diff --git a/plugins/Admin/README.rst b/plugins/Admin/README.rst index 4ccc039d5..1df3ce596 100644 --- a/plugins/Admin/README.rst +++ b/plugins/Admin/README.rst @@ -18,58 +18,63 @@ This is a core Supybot plugin that should not be removed! Commands -------- -.. _command-Admin-acmd: +.. _command-admin-acmd: acmd [ ...] Perform (with associated s on all channels on current network. -.. _command-Admin-capability.add: +.. _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: +.. _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: +.. _command-admin-channels: channels takes no arguments Returns the channels the bot is on. -.. _command-Admin-clearq: +.. _command-admin-clearq: clearq takes no arguments Clears the current send queue for this network. -.. _command-Admin-ignore.add: +.. _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: +.. _command-admin-ignore.list: ignore list takes no arguments Lists the hostmasks that the bot is ignoring. -.. _command-Admin-ignore.remove: +.. _command-admin-ignore.remove: ignore remove This will remove the persistent ignore on or the hostmask currently associated with . -.. _command-Admin-join: +.. _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: +.. _command-admin-nick: nick [] [] Changes the bot's nick to . If no nick is given, returns the bot's current nick. +.. _conf-Admin: + Configuration ------------- + +.. _conf-supybot.plugins.Admin.public: + supybot.plugins.Admin.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Aka/README.rst b/plugins/Aka/README.rst index 6c624494c..7f08b7cca 100644 --- a/plugins/Aka/README.rst +++ b/plugins/Aka/README.rst @@ -76,58 +76,65 @@ reply with the same information, the result of those commands. Commands -------- -.. _command-Aka-add: +.. _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: +.. _command-aka-remove: remove [--channel <#channel>] Removes the given alias, if unlocked. -.. _command-Aka-lock: +.. _command-aka-lock: lock [--channel <#channel>] Locks an alias so that no one else can change it. -.. _command-Aka-unlock: +.. _command-aka-unlock: unlock [--channel <#channel>] Unlocks an alias so that people can define new aliases over it. -.. _command-Aka-importaliasdatabase: +.. _command-aka-importaliasdatabase: importaliasdatabase takes no arguments Imports the Alias database into Aka's, and clean the former. -.. _command-Aka-show: +.. _command-aka-show: show [--channel <#channel>] This command shows the content of an Aka. -.. _command-Aka-list: +.. _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: +.. _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: +.. _command-aka-search: search [--channel <#channel>] Searches Akas defined for . If is not specified, searches all global Akas. +.. _conf-Aka: + Configuration ------------- + +.. _conf-supybot.plugins.Aka.maximumWordsInName: + supybot.plugins.Aka.maximumWordsInName This config variable defaults to "5", is not network-specific, and is not channel-specific. The maximum number of words allowed in a command name. Setting this to an high value may slow down your bot on long commands. +.. _conf-supybot.plugins.Aka.public: + supybot.plugins.Aka.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Alias/README.rst b/plugins/Alias/README.rst index b9726311b..b17ae362b 100644 --- a/plugins/Alias/README.rst +++ b/plugins/Alias/README.rst @@ -36,38 +36,45 @@ reply with the same information, the result of those commands. Commands -------- -.. _command-Alias-add: +.. _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: +.. _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: +.. _command-alias-lock: lock Locks an alias so that no one else can change it. -.. _command-Alias-remove: +.. _command-alias-remove: remove Removes the given alias, if unlocked. -.. _command-Alias-unlock: +.. _command-alias-unlock: unlock Unlocks an alias so that people can define new aliases over it. +.. _conf-Alias: + Configuration ------------- + +.. _conf-supybot.plugins.Alias.public: + supybot.plugins.Alias.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Alias.validName: + supybot.plugins.Alias.validName This config variable defaults to "^[^\\x00-\\x20]+$", is not network-specific, and is not channel-specific. diff --git a/plugins/Anonymous/README.rst b/plugins/Anonymous/README.rst index c4a261b85..38a8dac18 100644 --- a/plugins/Anonymous/README.rst +++ b/plugins/Anonymous/README.rst @@ -48,48 +48,61 @@ This Commands -------- -.. _command-Anonymous-do: +.. _command-anonymous-do: do Performs in . -.. _command-Anonymous-react: +.. _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: +.. _command-anonymous-say: say Sends to . -.. _command-Anonymous-tell: +.. _command-anonymous-tell: tell Sends to . Can only be used if supybot.plugins.Anonymous.allowPrivateTarget is True. +.. _conf-Anonymous: + Configuration ------------- + +.. _conf-supybot.plugins.Anonymous.allowPrivateTarget: + supybot.plugins.Anonymous.allowPrivateTarget This config variable defaults to "False", is not network-specific, and is not channel-specific. Determines whether the bot will allow the "tell" command to be used. If true, the bot will allow the "tell" command to send private messages to other users. +.. _conf-supybot.plugins.Anonymous.public: + supybot.plugins.Anonymous.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Anonymous.requireCapability: + supybot.plugins.Anonymous.requireCapability This config variable defaults to "", is network-specific, and is channel-specific. Determines what capability (if any) the bot should require people trying to use this plugin to have. +.. _conf-supybot.plugins.Anonymous.requirePresenceInChannel: + supybot.plugins.Anonymous.requirePresenceInChannel This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot should require people trying to use this plugin to be in the channel they wish to anonymously send to. +.. _conf-supybot.plugins.Anonymous.requireRegistration: + supybot.plugins.Anonymous.requireRegistration This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/AutoMode/README.rst b/plugins/AutoMode/README.rst index 6944fab27..7720aad90 100644 --- a/plugins/AutoMode/README.rst +++ b/plugins/AutoMode/README.rst @@ -26,63 +26,90 @@ This plugin also kbans people on ``@channel ban list`` lower capability is enabled, that is also applied to users with higher capability (``config plugins.automode.fallthrough``). +.. _conf-AutoMode: + Configuration ------------- + +.. _conf-supybot.plugins.AutoMode.alternativeCapabilities: + supybot.plugins.AutoMode.alternativeCapabilities This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will check for 'alternative capabilities' (ie. autoop, autohalfop, autovoice) in addition to/instead of classic ones. +.. _conf-supybot.plugins.AutoMode.ban: + supybot.plugins.AutoMode.ban This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will automatically ban people who join the channel and are on the banlist. +.. _conf-supybot.plugins.AutoMode.ban.period: + supybot.plugins.AutoMode.ban.period This config variable defaults to "86400", is network-specific, and is channel-specific. Determines how many seconds the bot will automatically ban a person when banning. +.. _conf-supybot.plugins.AutoMode.delay: + supybot.plugins.AutoMode.delay This config variable defaults to "0", is network-specific, and is channel-specific. Determines how many seconds the bot will wait before applying a mode. Has no effect on bans. +.. _conf-supybot.plugins.AutoMode.enable: + supybot.plugins.AutoMode.enable This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether this plugin is enabled. +.. _conf-supybot.plugins.AutoMode.extra: + supybot.plugins.AutoMode.extra This config variable defaults to " ", is network-specific, and is channel-specific. Extra modes that will be applied to a user. Example syntax: user1+o-v user2+v user3-v +.. _conf-supybot.plugins.AutoMode.fallthrough: + supybot.plugins.AutoMode.fallthrough This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will "fall through" to halfop/voicing when auto-opping is turned off but auto-halfopping/voicing are turned on. +.. _conf-supybot.plugins.AutoMode.halfop: + supybot.plugins.AutoMode.halfop This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will automatically halfop people with the ,halfop capability when they join the channel. +.. _conf-supybot.plugins.AutoMode.op: + supybot.plugins.AutoMode.op This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will automatically op people with the ,op capability when they join the channel. +.. _conf-supybot.plugins.AutoMode.owner: + supybot.plugins.AutoMode.owner This config variable defaults to "False", is not network-specific, and is not channel-specific. Determines whether this plugin will automode owners even if they don't have op/halfop/voice/whatever capability. +.. _conf-supybot.plugins.AutoMode.public: + supybot.plugins.AutoMode.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.AutoMode.voice: + supybot.plugins.AutoMode.voice This config variable defaults to "False", is network-specific, and is channel-specific. diff --git a/plugins/Autocomplete/README.rst b/plugins/Autocomplete/README.rst index 858b274c9..f164bcf38 100644 --- a/plugins/Autocomplete/README.rst +++ b/plugins/Autocomplete/README.rst @@ -19,13 +19,20 @@ Usage ----- Provides command completion for IRC clients that support it. +.. _conf-Autocomplete: + Configuration ------------- + +.. _conf-supybot.plugins.Autocomplete.enabled: + supybot.plugins.Autocomplete.enabled This config variable defaults to "False", is network-specific, and is channel-specific. Whether the bot should reply to autocomplete requests from clients. +.. _conf-supybot.plugins.Autocomplete.public: + supybot.plugins.Autocomplete.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/BadWords/README.rst b/plugins/BadWords/README.rst index f0b995616..79ef2c02e 100644 --- a/plugins/BadWords/README.rst +++ b/plugins/BadWords/README.rst @@ -20,68 +20,91 @@ has op. Commands -------- -.. _command-BadWords-add: +.. _command-badwords-add: add [ ...] Adds all s to the list of words being censored. -.. _command-BadWords-list: +.. _command-badwords-list: list takes no arguments Returns the list of words being censored. -.. _command-BadWords-remove: +.. _command-badwords-remove: remove [ ...] Removes s from the list of words being censored. +.. _conf-BadWords: + Configuration ------------- + +.. _conf-supybot.plugins.BadWords.kick: + supybot.plugins.BadWords.kick This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will kick people with a warning when they use bad words. +.. _conf-supybot.plugins.BadWords.kick.message: + supybot.plugins.BadWords.kick.message This config variable defaults to "You have been kicked for using a word prohibited in the presence of this bot. Please use more appropriate language in the future.", is network-specific, and is channel-specific. Determines the kick message used by the bot when kicking users for saying bad words. +.. _conf-supybot.plugins.BadWords.nastyChars: + supybot.plugins.BadWords.nastyChars This config variable defaults to "!@#&", is not network-specific, and is not channel-specific. Determines what characters will replace bad words; a chunk of these characters matching the size of the replaced bad word will be used to replace the bad words you've configured. +.. _conf-supybot.plugins.BadWords.phrases: + supybot.plugins.BadWords.phrases This config variable defaults to " ", is not network-specific, and is not channel-specific. Comma-separated groups of words that are considered to be 'bad'. +.. _conf-supybot.plugins.BadWords.public: + supybot.plugins.BadWords.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.BadWords.replaceMethod: + supybot.plugins.BadWords.replaceMethod This config variable defaults to "nastyCharacters", is not network-specific, and is not channel-specific. Determines the manner in which bad words will be replaced. 'nastyCharacters' (the default) will replace a bad word with the same number of 'nasty characters' (like those used in comic books; configurable by supybot.plugins.BadWords.nastyChars). 'simple' will replace a bad word with a simple strings (regardless of the length of the bad word); this string is configurable via supybot.plugins.BadWords.simpleReplacement. Valid strings: simple and nastyCharacters. +.. _conf-supybot.plugins.BadWords.requireWordBoundaries: + supybot.plugins.BadWords.requireWordBoundaries This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will require bad words to be independent words, or whether it will censor them within other words. For instance, if 'darn' is a bad word, then if this is true, 'darn' will be censored, but 'darnit' will not. You probably want this to be false. After changing this setting, the BadWords regexp needs to be regenerated by adding/removing a word to the list, or reloading the plugin. +.. _conf-supybot.plugins.BadWords.simpleReplacement: + supybot.plugins.BadWords.simpleReplacement This config variable defaults to "[CENSORED]", is not network-specific, and is not channel-specific. Determines what word will replace bad words if the replacement method is 'simple'. +.. _conf-supybot.plugins.BadWords.stripFormatting: + supybot.plugins.BadWords.stripFormatting This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether the bot will strip formatting characters from messages before it checks them for bad words. If this is False, it will be relatively trivial to circumvent this plugin's filtering. If it's True, however, it will interact poorly with other plugins that do coloring or bolding of text. +.. _conf-supybot.plugins.BadWords.words: + supybot.plugins.BadWords.words This config variable defaults to " ", is not network-specific, and is not channel-specific. diff --git a/plugins/Channel/README.rst b/plugins/Channel/README.rst index 4bdcbf083..a36badcea 100644 --- a/plugins/Channel/README.rst +++ b/plugins/Channel/README.rst @@ -18,223 +18,236 @@ a core Supybot plugin that should not be removed! Commands -------- -.. _command-Channel-alert: +.. _command-channel-alert: alert [] Sends to all the users in who have the ,op capability. -.. _command-Channel-ban.add: +.. _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: +.. _command-channel-ban.hostmask: ban hostmask [] Bans the from the . -.. _command-Channel-ban.list: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-channel-listbans: listbans [] List all bans on the channel. If is not given, it defaults to the current channel. -.. _command-Channel-lobotomy.add: +.. _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: +.. _command-channel-lobotomy.list: lobotomy list takes no arguments Returns the channels in which this bot is lobotomized. -.. _command-Channel-lobotomy.remove: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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. +.. _conf-Channel: + Configuration ------------- + +.. _conf-supybot.plugins.Channel.alwaysRejoin: + supybot.plugins.Channel.alwaysRejoin This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will always try to rejoin a channel whenever it's kicked from the channel. +.. _conf-supybot.plugins.Channel.nicksInPrivate: + supybot.plugins.Channel.nicksInPrivate This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the output of 'nicks' will be sent in private. This prevents mass-highlights of a channel's users, accidental or on purpose. +.. _conf-supybot.plugins.Channel.partMsg: + supybot.plugins.Channel.partMsg This config variable defaults to "Limnoria $version", is network-specific, and is channel-specific. Determines what part message should be used by default. If the part command is called without a part message, this will be used. If this value is empty, then no part message will be used (they are optional in the IRC protocol). The standard substitutions ($version, $nick, etc.) are all handled appropriately. +.. _conf-supybot.plugins.Channel.public: + supybot.plugins.Channel.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Channel.rejoinDelay: + supybot.plugins.Channel.rejoinDelay This config variable defaults to "0", is network-specific, and is channel-specific. diff --git a/plugins/ChannelLogger/README.rst b/plugins/ChannelLogger/README.rst index b292e0a08..69288ab01 100644 --- a/plugins/ChannelLogger/README.rst +++ b/plugins/ChannelLogger/README.rst @@ -11,78 +11,111 @@ Usage ----- This plugin allows the bot to log channel conversations to disk. +.. _conf-ChannelLogger: + Configuration ------------- + +.. _conf-supybot.plugins.ChannelLogger.directories: + supybot.plugins.ChannelLogger.directories This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether the bot will partition its channel logs into separate directories based on different criteria. +.. _conf-supybot.plugins.ChannelLogger.directories.channel: + supybot.plugins.ChannelLogger.directories.channel This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether the bot will use a channel directory if using directories. +.. _conf-supybot.plugins.ChannelLogger.directories.network: + supybot.plugins.ChannelLogger.directories.network This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether the bot will use a network directory if using directories. +.. _conf-supybot.plugins.ChannelLogger.directories.timestamp: + supybot.plugins.ChannelLogger.directories.timestamp This config variable defaults to "False", is not network-specific, and is not channel-specific. Determines whether the bot will use a timestamp (determined by supybot.plugins.ChannelLogger.directories.timestamp.format) if using directories. +.. _conf-supybot.plugins.ChannelLogger.directories.timestamp.format: + supybot.plugins.ChannelLogger.directories.timestamp.format This config variable defaults to "%B", is not network-specific, and is not channel-specific. Determines what timestamp format will be used in the directory structure for channel logs if supybot.plugins.ChannelLogger.directories.timestamp is True. +.. _conf-supybot.plugins.ChannelLogger.enable: + supybot.plugins.ChannelLogger.enable This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether logging is enabled. +.. _conf-supybot.plugins.ChannelLogger.filenameTimestamp: + supybot.plugins.ChannelLogger.filenameTimestamp This config variable defaults to "%Y-%m-%d", is network-specific, and is channel-specific. Determines how to represent the timestamp used for the filename in rotated logs. When this timestamp changes, the old logfiles will be closed and a new one started. The format characters for the timestamp are in the time.strftime docs at python.org. In order for your logs to be rotated, you'll also have to enable supybot.plugins.ChannelLogger.rotateLogs. +.. _conf-supybot.plugins.ChannelLogger.flushImmediately: + supybot.plugins.ChannelLogger.flushImmediately This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether channel logfiles will be flushed anytime they're written to, rather than being buffered by the operating system. +.. _conf-supybot.plugins.ChannelLogger.noLogPrefix: + supybot.plugins.ChannelLogger.noLogPrefix This config variable defaults to "[nolog]", is network-specific, and is channel-specific. Determines what string a message should be prefixed with in order not to be logged. If you don't want any such prefix, just set it to the empty string. +.. _conf-supybot.plugins.ChannelLogger.public: + supybot.plugins.ChannelLogger.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.ChannelLogger.rewriteRelayed: + supybot.plugins.ChannelLogger.rewriteRelayed This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will rewrite outgoing relayed messages (eg. from the Relay plugin) to use the original nick instead of the bot's nick. +.. _conf-supybot.plugins.ChannelLogger.rotateLogs: + supybot.plugins.ChannelLogger.rotateLogs This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will automatically rotate the logs for this channel. The bot will rotate logs when the timestamp for the log changes. The timestamp is set according to the 'filenameTimestamp' configuration variable. +.. _conf-supybot.plugins.ChannelLogger.showJoinParts: + supybot.plugins.ChannelLogger.showJoinParts This config variable defaults to "True", is network-specific, and is channel-specific. Determines wether joins and parts are logged +.. _conf-supybot.plugins.ChannelLogger.stripFormatting: + supybot.plugins.ChannelLogger.stripFormatting This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether formatting characters (such as bolding, color, etc.) are removed when writing the logs to disk. +.. _conf-supybot.plugins.ChannelLogger.timestamp: + supybot.plugins.ChannelLogger.timestamp This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/ChannelStats/README.rst b/plugins/ChannelStats/README.rst index 39f5dfddb..e83e556d2 100644 --- a/plugins/ChannelStats/README.rst +++ b/plugins/ChannelStats/README.rst @@ -18,38 +18,49 @@ the command 'channelstats'. Commands -------- -.. _command-ChannelStats-channelstats: +.. _command-channelstats-channelstats: channelstats [] Returns the statistics for . is only necessary if the message isn't sent on the channel itself. -.. _command-ChannelStats-rank: +.. _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: +.. _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. +.. _conf-ChannelStats: + Configuration ------------- + +.. _conf-supybot.plugins.ChannelStats.frowns: + supybot.plugins.ChannelStats.frowns This config variable defaults to ":| :-/ :-\\ :\\ :/ :( :-( :'(", is network-specific, and is channel-specific. Determines what words (i.e., pieces of text with no spaces in them) are considered 'frowns' for the purposes of stats-keeping. +.. _conf-supybot.plugins.ChannelStats.public: + supybot.plugins.ChannelStats.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.ChannelStats.selfStats: + supybot.plugins.ChannelStats.selfStats This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will keep channel statistics on itself, possibly skewing the channel stats (especially in cases where the bot is relaying between channels on a network). +.. _conf-supybot.plugins.ChannelStats.smileys: + supybot.plugins.ChannelStats.smileys This config variable defaults to ":) ;) ;] :-) :-D :D :P :p (= =)", is network-specific, and is channel-specific. diff --git a/plugins/Conditional/README.rst b/plugins/Conditional/README.rst index 11ab60110..09fa10d2c 100644 --- a/plugins/Conditional/README.rst +++ b/plugins/Conditional/README.rst @@ -21,98 +21,103 @@ commands and scripting. Commands -------- -.. _command-Conditional-cand: +.. _command-conditional-cand: cand [ ... ] Returns true if all conditions supplied evaluate to true. -.. _command-Conditional-ceq: +.. _command-conditional-ceq: ceq Does a string comparison on and . Returns true if they are equal. -.. _command-Conditional-cerror: +.. _command-conditional-cerror: cerror Runs and returns true if it raises an error; false otherwise. -.. _command-Conditional-cif: +.. _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: +.. _command-conditional-cor: cor [ ... ] Returns true if any one of conditions supplied evaluates to true. -.. _command-Conditional-cxor: +.. _command-conditional-cxor: cxor [ ... ] Returns true if only one of conditions supplied evaluates to true. -.. _command-Conditional-ge: +.. _command-conditional-ge: ge Does a string comparison on and . Returns true if is greater than or equal to . -.. _command-Conditional-gt: +.. _command-conditional-gt: gt Does a string comparison on and . Returns true if is greater than . -.. _command-Conditional-le: +.. _command-conditional-le: le Does a string comparison on and . Returns true if is less than or equal to . -.. _command-Conditional-lt: +.. _command-conditional-lt: lt Does a string comparison on and . Returns true if is less than . -.. _command-Conditional-match: +.. _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: +.. _command-conditional-nceq: nceq Does a numeric comparison on and . Returns true if they are equal. -.. _command-Conditional-ne: +.. _command-conditional-ne: ne Does a string comparison on and . Returns true if they are not equal. -.. _command-Conditional-nge: +.. _command-conditional-nge: nge Does a numeric comparison on and . Returns true if is greater than or equal to . -.. _command-Conditional-ngt: +.. _command-conditional-ngt: ngt Does a numeric comparison on and . Returns true if is greater than . -.. _command-Conditional-nle: +.. _command-conditional-nle: nle Does a numeric comparison on and . Returns true if is less than or equal to . -.. _command-Conditional-nlt: +.. _command-conditional-nlt: nlt Does a numeric comparison on and . Returns true if is less than . -.. _command-Conditional-nne: +.. _command-conditional-nne: nne Does a numeric comparison on and . Returns true if they are not equal. +.. _conf-Conditional: + Configuration ------------- + +.. _conf-supybot.plugins.Conditional.public: + supybot.plugins.Conditional.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Config/README.rst b/plugins/Config/README.rst index 972321686..03f9773e2 100644 --- a/plugins/Config/README.rst +++ b/plugins/Config/README.rst @@ -16,78 +16,83 @@ a core Supybot plugin that should not be removed! Commands -------- -.. _command-Config-channel: +.. _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: +.. _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: +.. _command-config-default: default Returns the default value of the configuration variable . -.. _command-Config-export: +.. _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: +.. _command-config-help: help Returns the description of the configuration variable . -.. _command-Config-list: +.. _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: +.. _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: +.. _command-config-reload: reload takes no arguments Reloads the various configuration files (user database, channel database, registry, etc.). -.. _command-Config-reset.channel: +.. _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: +.. _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: +.. _command-config-search: search Searches for in the current configuration variables. -.. _command-Config-searchhelp: +.. _command-config-searchhelp: searchhelp Searches for in the help of current configuration variables. -.. _command-Config-searchvalues: +.. _command-config-searchvalues: searchvalues Searches for in the values of current configuration variables. -.. _command-Config-setdefault: +.. _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. +.. _conf-Config: + Configuration ------------- + +.. _conf-supybot.plugins.Config.public: + supybot.plugins.Config.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Ctcp/README.rst b/plugins/Ctcp/README.rst index e14b48d25..a2abc97a5 100644 --- a/plugins/Ctcp/README.rst +++ b/plugins/Ctcp/README.rst @@ -20,23 +20,32 @@ mode +C or similar which prevents CTCP requests to channel. Commands -------- -.. _command-Ctcp-version: +.. _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. +.. _conf-Ctcp: + Configuration ------------- + +.. _conf-supybot.plugins.Ctcp.public: + supybot.plugins.Ctcp.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Ctcp.userinfo: + supybot.plugins.Ctcp.userinfo This config variable defaults to "", is not network-specific, and is not channel-specific. Determines what will be sent when a USERINFO query is received. +.. _conf-supybot.plugins.Ctcp.versionWait: + supybot.plugins.Ctcp.versionWait This config variable defaults to "10", is not network-specific, and is not channel-specific. diff --git a/plugins/DDG/README.rst b/plugins/DDG/README.rst index b15ed3a36..b824ead2e 100644 --- a/plugins/DDG/README.rst +++ b/plugins/DDG/README.rst @@ -20,33 +20,46 @@ Example:: Commands -------- -.. _command-DDG-search: +.. _command-ddg-search: search Searches for on DuckDuckGo's web search. +.. _conf-DDG: + Configuration ------------- + +.. _conf-supybot.plugins.DDG.maxResults: + supybot.plugins.DDG.maxResults This config variable defaults to "4", is network-specific, and is channel-specific. Determines the maximum number of results the bot will respond with. +.. _conf-supybot.plugins.DDG.public: + supybot.plugins.DDG.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.DDG.region: + supybot.plugins.DDG.region This config variable defaults to "", is network-specific, and is channel-specific. Set the DDG search region to return results for the language/country of your choice. E.g. 'us-en' for United States. https://duckduckgo.com/params +.. _conf-supybot.plugins.DDG.searchFilter: + supybot.plugins.DDG.searchFilter This config variable defaults to "moderate", is network-specific, and is channel-specific. Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering Valid strings: active, moderate, and off. +.. _conf-supybot.plugins.DDG.showSnippet: + supybot.plugins.DDG.showSnippet This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/Debug/README.rst b/plugins/Debug/README.rst index 787b61e0e..99ca4bffc 100644 --- a/plugins/Debug/README.rst +++ b/plugins/Debug/README.rst @@ -18,58 +18,63 @@ should not be loaded with a default installation. Commands -------- -.. _command-Debug-channeldb: +.. _command-debug-channeldb: channeldb [] Returns the result of the channeldb converter. -.. _command-Debug-collect: +.. _command-debug-collect: collect [] Does gc collections, returning the number of objects collected each time. defaults to 1. -.. _command-Debug-environ: +.. _command-debug-environ: environ takes no arguments Returns the environment of the supybot process. -.. _command-Debug-eval: +.. _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: +.. _command-debug-exec: exec Execs . Returns success if it didn't raise any exceptions. -.. _command-Debug-exn: +.. _command-debug-exn: exn Raises the exception matching . -.. _command-Debug-sendquote: +.. _command-debug-sendquote: sendquote Sends (not queues) the raw IRC message given. -.. _command-Debug-settrace: +.. _command-debug-settrace: settrace [] Starts tracing function calls to . If is not given, sys.stdout is used. This causes much output. -.. _command-Debug-simpleeval: +.. _command-debug-simpleeval: simpleeval Evaluates the given expression. -.. _command-Debug-unsettrace: +.. _command-debug-unsettrace: unsettrace takes no arguments Stops tracing function calls on stdout. +.. _conf-Debug: + Configuration ------------- + +.. _conf-supybot.plugins.Debug.public: + supybot.plugins.Debug.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Dict/README.rst b/plugins/Dict/README.rst index a388b82e5..65d3790ac 100644 --- a/plugins/Dict/README.rst +++ b/plugins/Dict/README.rst @@ -21,43 +21,54 @@ dictionaries. Commands -------- -.. _command-Dict-dict: +.. _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: +.. _command-dict-dictionaries: dictionaries takes no arguments Returns the dictionaries valid for the dict command. -.. _command-Dict-random: +.. _command-dict-random: random takes no arguments Returns a random valid dictionary. -.. _command-Dict-synonym: +.. _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. +.. _conf-Dict: + Configuration ------------- + +.. _conf-supybot.plugins.Dict.default: + supybot.plugins.Dict.default This config variable defaults to "*", is network-specific, and is channel-specific. Determines the default dictionary the bot will ask for definitions in. If this value is '*' (without the quotes) the bot will use all dictionaries to define words. +.. _conf-supybot.plugins.Dict.public: + supybot.plugins.Dict.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Dict.server: + supybot.plugins.Dict.server This config variable defaults to "dict.org", is not network-specific, and is not channel-specific. Determines what server the bot will retrieve definitions from. +.. _conf-supybot.plugins.Dict.showDictName: + supybot.plugins.Dict.showDictName This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/Dunno/README.rst b/plugins/Dunno/README.rst index 0daaf144d..7fbed79d3 100644 --- a/plugins/Dunno/README.rst +++ b/plugins/Dunno/README.rst @@ -22,43 +22,50 @@ responses. Commands -------- -.. _command-Dunno-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-dunno-search: search [] [--{regexp,by} ] [] Searches for dunnos matching the criteria given. -.. _command-Dunno-stats: +.. _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. +.. _conf-Dunno: + Configuration ------------- + +.. _conf-supybot.plugins.Dunno.prefixNick: + supybot.plugins.Dunno.prefixNick This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will prefix the nick of the user giving an invalid command to the "dunno" response. +.. _conf-supybot.plugins.Dunno.public: + supybot.plugins.Dunno.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Factoids/README.rst b/plugins/Factoids/README.rst index b8fbe30fa..995c1385c 100644 --- a/plugins/Factoids/README.rst +++ b/plugins/Factoids/README.rst @@ -16,103 +16,124 @@ Provides the ability to show Factoids. Commands -------- -.. _command-Factoids-alias: +.. _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: +.. _command-factoids-change: change [] Changes the factoid # associated with according to . -.. _command-Factoids-forget: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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. +.. _conf-Factoids: + Configuration ------------- + +.. _conf-supybot.plugins.Factoids.format: + supybot.plugins.Factoids.format This config variable defaults to "$value", is network-specific, and is channel-specific. Determines the format of the response given when a factoid's value is requested. All the standard substitutes apply, in addition to "$key" for the factoid's key and "$value" for the factoid's value. +.. _conf-supybot.plugins.Factoids.keepRankInfo: + supybot.plugins.Factoids.keepRankInfo This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether we keep updating the usage count for each factoid, for popularity ranking. +.. _conf-supybot.plugins.Factoids.learnSeparator: + supybot.plugins.Factoids.learnSeparator This config variable defaults to "is", is network-specific, and is channel-specific. Determines what separator must be used in the learn command. Defaults to 'is' -- learn is . Users might want to change this to something else, so it's configurable. +.. _conf-supybot.plugins.Factoids.public: + supybot.plugins.Factoids.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Factoids.rankListLength: + supybot.plugins.Factoids.rankListLength This config variable defaults to "20", is network-specific, and is channel-specific. Determines the number of factoid keys returned by the factrank command. +.. _conf-supybot.plugins.Factoids.replyApproximateSearchKeys: + supybot.plugins.Factoids.replyApproximateSearchKeys This config variable defaults to "True", is network-specific, and is channel-specific. If you try to look up a nonexistent factoid, this setting make the bot try to find some possible matching keys through several approximate matching algorithms and return a list of matching keys, before giving up. +.. _conf-supybot.plugins.Factoids.replyWhenInvalidCommand: + supybot.plugins.Factoids.replyWhenInvalidCommand This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will reply to invalid commands by searching for a factoid; basically making the whatis unnecessary when you want all factoids for a given key. +.. _conf-supybot.plugins.Factoids.requireVoice: + supybot.plugins.Factoids.requireVoice This config variable defaults to "False", is network-specific, and is channel-specific. Only allows a user with voice or above on a channel to use the 'learn' and 'forget' commands. +.. _conf-supybot.plugins.Factoids.showFactoidIfOnlyOneMatch: + supybot.plugins.Factoids.showFactoidIfOnlyOneMatch This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/Fediverse/README.rst b/plugins/Fediverse/README.rst index a9172ca99..f65f792c6 100644 --- a/plugins/Fediverse/README.rst +++ b/plugins/Fediverse/README.rst @@ -33,32 +33,59 @@ Usage ----- Fetches information from ActivityPub servers. +Enabling Secure Fetch +^^^^^^^^^^^^^^^^^^^^^ + +The default configuration works with most ActivityPub servers, but not +all of them, because they require an HTTP Signature to fetch profiles +and statuses. + +Because of how HTTP Signatures work, you need to add some configuration +for Limnoria to support it. + +First, you should set ``supybot.servers.http.port`` to a port you want +your bot to listen on (by default it's 8080). If there are already +plugins using it (eg. if Fediverse is already running), you should +either unload all of them and load them back, or restart your bot. + +Then, you must configure a reverse-proxy in front of your bot (eg. nginx), +and it must support HTTPS. + +Finally, set ``supybot.servers.http.publicUrl`` to the public URL of this +server (when opening this URL in your browser, it should show a page with +a title like "Supybot web server index"). + .. _commands-Fediverse: Commands -------- -.. _command-Fediverse-featured: +.. _command-fediverse-featured: featured <@user@instance> Returnes the featured statuses of @user@instance (aka. pinned toots). -.. _command-Fediverse-profile: +.. _command-fediverse-profile: profile <@user@instance> Returns generic information on the account @user@instance. -.. _command-Fediverse-status: +.. _command-fediverse-status: status Shows the content of the status at . -.. _command-Fediverse-statuses: +.. _command-fediverse-statuses: statuses <@user@instance> Returned the last statuses of @user@instance. +.. _conf-Fediverse: + Configuration ------------- + +.. _conf-supybot.plugins.Fediverse.public: + supybot.plugins.Fediverse.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Filter/README.rst b/plugins/Filter/README.rst index c390c2e4f..8b73a5145 100644 --- a/plugins/Filter/README.rst +++ b/plugins/Filter/README.rst @@ -26,148 +26,153 @@ Not very useful, but definitely quite fun :) Commands -------- -.. _command-Filter-aol: +.. _command-filter-aol: aol Returns as if an AOL user had said it. -.. _command-Filter-binary: +.. _command-filter-binary: binary Returns the binary representation of . -.. _command-Filter-caps: +.. _command-filter-caps: caps EVERYONE LOVES CAPS LOCK. -.. _command-Filter-capwords: +.. _command-filter-capwords: capwords Capitalises the first letter of each word. -.. _command-Filter-colorize: +.. _command-filter-colorize: colorize Returns with each character randomly colorized. -.. _command-Filter-gnu: +.. _command-filter-gnu: gnu Returns as GNU/RMS would say it. -.. _command-Filter-hebrew: +.. _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: +.. _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: +.. _command-filter-jeffk: jeffk Returns as if JeffK had said it himself. -.. _command-Filter-leet: +.. _command-filter-leet: leet Returns the l33tspeak version of -.. _command-Filter-morse: +.. _command-filter-morse: morse Gives the Morse code equivalent of a given string. -.. _command-Filter-outfilter: +.. _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: +.. _command-filter-rainbow: rainbow Returns colorized like a rainbow. -.. _command-Filter-reverse: +.. _command-filter-reverse: reverse Reverses . -.. _command-Filter-rot13: +.. _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: +.. _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: +.. _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: +.. _command-filter-spellit: spellit Returns , phonetically spelled out. -.. _command-Filter-squish: +.. _command-filter-squish: squish Removes all the spaces from . -.. _command-Filter-stripcolor: +.. _command-filter-stripcolor: stripcolor Returns stripped of all color codes. -.. _command-Filter-supa1337: +.. _command-filter-supa1337: supa1337 Replies with an especially k-rad translation of . -.. _command-Filter-unbinary: +.. _command-filter-unbinary: unbinary Returns the character representation of binary . Assumes ASCII, 8 digits per character. -.. _command-Filter-undup: +.. _command-filter-undup: undup Returns , with all consecutive duplicated letters removed. -.. _command-Filter-unhexlify: +.. _command-filter-unhexlify: unhexlify Returns the string corresponding to . Obviously, must be a string of hexadecimal digits. -.. _command-Filter-uniud: +.. _command-filter-uniud: uniud Returns rotated 180 degrees. Only really works for ASCII printable characters. -.. _command-Filter-unmorse: +.. _command-filter-unmorse: unmorse Does the reverse of the morse command. -.. _command-Filter-uwu: +.. _command-filter-uwu: uwu Returns in uwu-speak. -.. _command-Filter-vowelrot: +.. _command-filter-vowelrot: vowelrot Returns with vowels rotated +.. _conf-Filter: + Configuration ------------- + +.. _conf-supybot.plugins.Filter.public: + supybot.plugins.Filter.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Format/README.rst b/plugins/Format/README.rst index 74e0b05c5..7cd9ccbd5 100644 --- a/plugins/Format/README.rst +++ b/plugins/Format/README.rst @@ -19,93 +19,98 @@ capitalized. Commands -------- -.. _command-Format-bold: +.. _command-format-bold: bold Returns bolded. -.. _command-Format-capitalize: +.. _command-format-capitalize: capitalize Returns capitalized. -.. _command-Format-color: +.. _command-format-color: color [] Returns with foreground color and background color (if given) -.. _command-Format-concat: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-format-join: join [ ...] Joins all the arguments together with . -.. _command-Format-lower: +.. _command-format-lower: lower Returns lowercased. -.. _command-Format-replace: +.. _command-format-replace: replace Replaces all non-overlapping occurrences of with in . -.. _command-Format-repr: +.. _command-format-repr: repr Returns surrounded by double quotes. -.. _command-Format-reverse: +.. _command-format-reverse: reverse Returns in reverse-video. -.. _command-Format-stripformatting: +.. _command-format-stripformatting: stripformatting Strips bold, underline, and colors from . -.. _command-Format-title: +.. _command-format-title: title Returns titlecased. -.. _command-Format-translate: +.. _command-format-translate: translate Replaces with in . The first and second arguments must necessarily be the same length. -.. _command-Format-underline: +.. _command-format-underline: underline Returns underlined. -.. _command-Format-upper: +.. _command-format-upper: upper Returns uppercased. +.. _conf-Format: + Configuration ------------- + +.. _conf-supybot.plugins.Format.public: + supybot.plugins.Format.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/GPG/README.rst b/plugins/GPG/README.rst index 2f4bff860..1df47dda7 100644 --- a/plugins/GPG/README.rst +++ b/plugins/GPG/README.rst @@ -15,33 +15,38 @@ Provides authentication based on GPG keys. Commands -------- -.. _command-GPG-key.add: +.. _command-gpg-key.add: key add Add a GPG key to your account. -.. _command-GPG-key.list: +.. _command-gpg-key.list: key list takes no arguments List your GPG keys. -.. _command-GPG-key.remove: +.. _command-gpg-key.remove: key remove Remove a GPG key from your account. -.. _command-GPG-signing.auth: +.. _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: +.. _command-gpg-signing.gettoken: signing gettoken takes no arguments Send you a token that you'll have to sign with your key. +.. _conf-GPG: + Configuration ------------- + +.. _conf-supybot.plugins.GPG.public: + supybot.plugins.GPG.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Games/README.rst b/plugins/Games/README.rst index f80c32243..f19c410d3 100644 --- a/plugins/Games/README.rst +++ b/plugins/Games/README.rst @@ -18,33 +18,38 @@ eightball, monologue, coin and dice. Commands -------- -.. _command-Games-coin: +.. _command-games-coin: coin takes no arguments Flips a coin and returns the result. -.. _command-Games-dice: +.. _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: +.. _command-games-eightball: eightball [] Ask a question and the answer shall be provided. -.. _command-Games-monologue: +.. _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: +.. _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. +.. _conf-Games: + Configuration ------------- + +.. _conf-supybot.plugins.Games.public: + supybot.plugins.Games.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Google/README.rst b/plugins/Google/README.rst index 008d73f2e..71d1a0650 100644 --- a/plugins/Google/README.rst +++ b/plugins/Google/README.rst @@ -40,88 +40,111 @@ Check: `Supported language codes`_ Commands -------- -.. _command-Google-cache: +.. _command-google-cache: cache Returns a link to the cached version of if it is available. -.. _command-Google-calc: +.. _command-google-calc: calc Uses Google's calculator to calculate the value of . -.. _command-Google-fight: +.. _command-google-fight: fight [ ...] Returns the results of each search, in order, from greatest number of results to least. -.. _command-Google-google: +.. _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: +.. _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: +.. _command-google-phonebook: phonebook Looks up on Google. -.. _command-Google-translate: +.. _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 +.. _conf-Google: + Configuration ------------- + +.. _conf-supybot.plugins.Google.baseUrl: + supybot.plugins.Google.baseUrl This config variable defaults to "google.com", is network-specific, and is channel-specific. Determines the base URL used for requests. +.. _conf-supybot.plugins.Google.bold: + supybot.plugins.Google.bold This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether results are bolded. +.. _conf-supybot.plugins.Google.colorfulFilter: + supybot.plugins.Google.colorfulFilter This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the word 'google' in the bot's output will be made colorful (like Google's logo). +.. _conf-supybot.plugins.Google.defaultLanguage: + supybot.plugins.Google.defaultLanguage This config variable defaults to "lang_en", is network-specific, and is channel-specific. Determines what default language is used in searches. If left empty, no specific language will be requested. Valid strings: lang_af, lang_sq, lang_am, lang_ar, lang_hy, lang_az, lang_eu, lang_be, lang_bn, lang_bg, lang_my, lang_ca, lang_zh, lang_zh-CN, lang_zh-TW, lang_hr, lang_cs, lang_da, lang_dv, lang_nl, lang_en, lang_eo, lang_et, lang_tl, lang_fi, lang_fr, lang_gl, lang_ka, lang_de, lang_el, lang_gu, lang_iw, lang_hi, lang_hu, lang_is, lang_id, lang_iu, lang_it, lang_ja, lang_kn, lang_kk, lang_km, lang_ko, lang_ku, lang_ky, lang_lo, lang_lv, lang_lt, lang_mk, lang_ms, lang_ml, lang_mt, lang_mr, lang_mn, lang_ne, lang_no, lang_or, lang_ps, lang_fa, lang_pl, lang_pt-PT, lang_pa, lang_ro, lang_ru, lang_sa, lang_sr, lang_sd, lang_si, lang_sk, lang_sl, lang_es, lang_sv, lang_tg, lang_ta, lang_tl, lang_te, lang_th, lang_bo, lang_tr, lang_uk, lang_ur, lang_uz, lang_ug, lang_vi, and lang_auto. +.. _conf-supybot.plugins.Google.maximumResults: + supybot.plugins.Google.maximumResults This config variable defaults to "3", is network-specific, and is channel-specific. Determines the maximum number of results returned from the google command. +.. _conf-supybot.plugins.Google.oneToOne: + supybot.plugins.Google.oneToOne This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether results are sent in different lines or all in the same one. +.. _conf-supybot.plugins.Google.public: + supybot.plugins.Google.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Google.referer: + supybot.plugins.Google.referer This config variable defaults to "", is not network-specific, and is not channel-specific. Determines the URL that will be sent to Google for the Referer field of the search requests. If this value is empty, a Referer will be generated in the following format: http://$server/$botName +.. _conf-supybot.plugins.Google.searchFilter: + supybot.plugins.Google.searchFilter This config variable defaults to "moderate", is network-specific, and is channel-specific. Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering Valid strings: active, moderate, and off. +.. _conf-supybot.plugins.Google.searchSnarfer: + supybot.plugins.Google.searchSnarfer This config variable defaults to "False", is network-specific, and is channel-specific. diff --git a/plugins/Hashes/README.rst b/plugins/Hashes/README.rst index a8a9cb74b..fe5f545cc 100644 --- a/plugins/Hashes/README.rst +++ b/plugins/Hashes/README.rst @@ -15,38 +15,43 @@ Provides hash or encryption related commands Commands -------- -.. _command-Hashes-algorithms: +.. _command-hashes-algorithms: algorithms Returns the list of available algorithms. -.. _command-Hashes-md5: +.. _command-hashes-md5: md5 Returns the md5 hash of a given string. -.. _command-Hashes-mkhash: +.. _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: +.. _command-hashes-sha: sha Returns the SHA1 hash of a given string. -.. _command-Hashes-sha256: +.. _command-hashes-sha256: sha256 Returns a SHA256 hash of the given string. -.. _command-Hashes-sha512: +.. _command-hashes-sha512: sha512 Returns a SHA512 hash of the given string. +.. _conf-Hashes: + Configuration ------------- + +.. _conf-supybot.plugins.Hashes.public: + supybot.plugins.Hashes.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Herald/README.rst b/plugins/Herald/README.rst index 260955f77..665c1618a 100644 --- a/plugins/Herald/README.rst +++ b/plugins/Herald/README.rst @@ -17,73 +17,94 @@ are recognized by the bot when they join a channel. Commands -------- -.. _command-Herald-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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. +.. _conf-Herald: + Configuration ------------- + +.. _conf-supybot.plugins.Herald.default: + supybot.plugins.Herald.default This config variable defaults to "", is network-specific, and is channel-specific. Sets the default herald to use. If a user has a personal herald specified, that will be used instead. If set to the empty string, the default herald will be disabled. +.. _conf-supybot.plugins.Herald.default.notice: + supybot.plugins.Herald.default.notice This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the default herald will be sent as a NOTICE instead of a PRIVMSG. +.. _conf-supybot.plugins.Herald.default.public: + supybot.plugins.Herald.default.public This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the default herald will be sent publicly. +.. _conf-supybot.plugins.Herald.heralding: + supybot.plugins.Herald.heralding This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether messages will be sent to the channel when a recognized user joins; basically enables or disables the plugin. +.. _conf-supybot.plugins.Herald.public: + supybot.plugins.Herald.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Herald.requireCapability: + supybot.plugins.Herald.requireCapability This config variable defaults to "", is not network-specific, and is not channel-specific. Determines what capability (if any) is required to add/change/remove the herald of another user. +.. _conf-supybot.plugins.Herald.throttle: + supybot.plugins.Herald.throttle This config variable defaults to "600", is network-specific, and is channel-specific. Determines the minimum number of seconds between heralds. +.. _conf-supybot.plugins.Herald.throttle.afterPart: + supybot.plugins.Herald.throttle.afterPart This config variable defaults to "0", is network-specific, and is channel-specific. Determines the minimum number of seconds after parting that the bot will not herald the person when they rejoin. +.. _conf-supybot.plugins.Herald.throttle.afterSplit: + supybot.plugins.Herald.throttle.afterSplit This config variable defaults to "60", is network-specific, and is channel-specific. diff --git a/plugins/Internet/README.rst b/plugins/Internet/README.rst index 8c6b33024..036040186 100644 --- a/plugins/Internet/README.rst +++ b/plugins/Internet/README.rst @@ -17,23 +17,28 @@ and convert IPs to hex. Commands -------- -.. _command-Internet-dns: +.. _command-internet-dns: dns Returns the ip of or the reverse DNS hostname of . -.. _command-Internet-hexip: +.. _command-internet-hexip: hexip Returns the hexadecimal IP for that IP. -.. _command-Internet-whois: +.. _command-internet-whois: whois Returns WHOIS information on the registration of . +.. _conf-Internet: + Configuration ------------- + +.. _conf-supybot.plugins.Internet.public: + supybot.plugins.Internet.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Karma/README.rst b/plugins/Karma/README.rst index b65b8e79b..46293dfcb 100644 --- a/plugins/Karma/README.rst +++ b/plugins/Karma/README.rst @@ -28,78 +28,101 @@ you must address the bot with nick or prefix to add or subtract karma. Commands -------- -.. _command-Karma-clear: +.. _command-karma-clear: clear [] [] Resets the karma of to 0. If is not given, resets everything. -.. _command-Karma-dump: +.. _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: +.. _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: +.. _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: +.. _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. +.. _conf-Karma: + Configuration ------------- + +.. _conf-supybot.plugins.Karma.allowSelfRating: + supybot.plugins.Karma.allowSelfRating This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether users can adjust the karma of their nick. +.. _conf-supybot.plugins.Karma.allowUnaddressedKarma: + supybot.plugins.Karma.allowUnaddressedKarma This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will increase/decrease karma without being addressed. +.. _conf-supybot.plugins.Karma.decrementChars: + supybot.plugins.Karma.decrementChars This config variable defaults to "--", is network-specific, and is channel-specific. A space separated list of characters to decrease karma. +.. _conf-supybot.plugins.Karma.incrementChars: + supybot.plugins.Karma.incrementChars This config variable defaults to "++", is network-specific, and is channel-specific. A space separated list of characters to increase karma. +.. _conf-supybot.plugins.Karma.mostDisplay: + supybot.plugins.Karma.mostDisplay This config variable defaults to "25", is network-specific, and is channel-specific. Determines how many karma things are shown when the most command is called. +.. _conf-supybot.plugins.Karma.onlyNicks: + supybot.plugins.Karma.onlyNicks This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will only increase/decrease karma for nicks in the current channel. +.. _conf-supybot.plugins.Karma.public: + supybot.plugins.Karma.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Karma.rankingDisplay: + supybot.plugins.Karma.rankingDisplay This config variable defaults to "3", is network-specific, and is channel-specific. Determines how many highest/lowest karma things are shown when karma is called with no arguments. +.. _conf-supybot.plugins.Karma.response: + supybot.plugins.Karma.response This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will reply with a success message when something's karma is increased or decreased. +.. _conf-supybot.plugins.Karma.simpleOutput: + supybot.plugins.Karma.simpleOutput This config variable defaults to "False", is network-specific, and is channel-specific. diff --git a/plugins/Lart/README.rst b/plugins/Lart/README.rst index 44d9747b8..da20825c3 100644 --- a/plugins/Lart/README.rst +++ b/plugins/Lart/README.rst @@ -23,48 +23,55 @@ Example: Commands -------- -.. _command-Lart-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-lart-search: search [] [--{regexp,by} ] [] Searches for larts matching the criteria given. -.. _command-Lart-stats: +.. _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. +.. _conf-Lart: + Configuration ------------- + +.. _conf-supybot.plugins.Lart.public: + supybot.plugins.Lart.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Lart.showIds: + supybot.plugins.Lart.showIds This config variable defaults to "False", is network-specific, and is channel-specific. diff --git a/plugins/Later/README.rst b/plugins/Later/README.rst index dc7bf4282..aab2e0c64 100644 --- a/plugins/Later/README.rst +++ b/plugins/Later/README.rst @@ -43,48 +43,61 @@ and the owner. Commands -------- -.. _command-Later-notes: +.. _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: +.. _command-later-remove: remove Removes the notes waiting on . -.. _command-Later-tell: +.. _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: +.. _command-later-undo: undo Removes the latest note you sent to . +.. _conf-Later: + Configuration ------------- + +.. _conf-supybot.plugins.Later.maximum: + supybot.plugins.Later.maximum This config variable defaults to "0", is not network-specific, and is not channel-specific. Determines the maximum number of messages to be queued for a user. If this value is 0, there is no maximum. +.. _conf-supybot.plugins.Later.messageExpiry: + supybot.plugins.Later.messageExpiry This config variable defaults to "30", is not network-specific, and is not channel-specific. Determines the maximum number of days that a message will remain queued for a user. After this time elapses, the message will be deleted. If this value is 0, there is no maximum. +.. _conf-supybot.plugins.Later.private: + supybot.plugins.Later.private This config variable defaults to "False", is not network-specific, and is not channel-specific. Determines whether users will be notified in the first place in which they're seen, or in private. +.. _conf-supybot.plugins.Later.public: + supybot.plugins.Later.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Later.tellOnJoin: + supybot.plugins.Later.tellOnJoin This config variable defaults to "False", is not network-specific, and is not channel-specific. diff --git a/plugins/Limiter/README.rst b/plugins/Limiter/README.rst index d28aa9aaf..af2003536 100644 --- a/plugins/Limiter/README.rst +++ b/plugins/Limiter/README.rst @@ -18,23 +18,34 @@ values appropriate to your channel (if the defaults aren't satisfactory). Once these are set, and someone enters/leaves the channel, Supybot will start setting the proper +l modes. +.. _conf-Limiter: + Configuration ------------- + +.. _conf-supybot.plugins.Limiter.enable: + supybot.plugins.Limiter.enable This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will maintain the channel limit to be slightly above the current number of people in the channel, in order to make clone/drone attacks harder. +.. _conf-supybot.plugins.Limiter.maximumExcess: + supybot.plugins.Limiter.maximumExcess This config variable defaults to "10", is network-specific, and is channel-specific. Determines the maximum number of free spots that will be saved when limits are being enforced. This should always be larger than supybot.plugins.Limiter.limit.minimumExcess. +.. _conf-supybot.plugins.Limiter.minimumExcess: + supybot.plugins.Limiter.minimumExcess This config variable defaults to "5", is network-specific, and is channel-specific. Determines the minimum number of free spots that will be saved when limits are being enforced. This should always be smaller than supybot.plugins.Limiter.limit.maximumExcess. +.. _conf-supybot.plugins.Limiter.public: + supybot.plugins.Limiter.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/LogToIrc/README.rst b/plugins/LogToIrc/README.rst index 8b1c2545f..d0f27ac4f 100644 --- a/plugins/LogToIrc/README.rst +++ b/plugins/LogToIrc/README.rst @@ -7,43 +7,62 @@ Purpose ------- Allows for sending the bot's logging output to channels or users. +.. _conf-LogToIrc: + Configuration ------------- + +.. _conf-supybot.plugins.LogToIrc.channelModesRequired: + supybot.plugins.LogToIrc.channelModesRequired This config variable defaults to "s", is network-specific, and is not channel-specific. Determines what channel modes a channel will be required to have for the bot to log to the channel. If this string is empty, no modes will be checked. +.. _conf-supybot.plugins.LogToIrc.color: + supybot.plugins.LogToIrc.color This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot's logs to IRC will be colorized with mIRC colors. +.. _conf-supybot.plugins.LogToIrc.level: + supybot.plugins.LogToIrc.level This config variable defaults to "WARNING", is network-specific, and is channel-specific. Determines what the minimum priority level logged will be to IRC. See supybot.log.level for possible values. DEBUG is disabled due to the large quantity of output. +.. _conf-supybot.plugins.LogToIrc.networks: + supybot.plugins.LogToIrc.networks This config variable defaults to " ", is not network-specific, and is not channel-specific. Determines what networks the bot should log to. If no networks are set, the bot will log on one network (whichever happens to be around at the time it feels like logging). +.. _conf-supybot.plugins.LogToIrc.notice: + supybot.plugins.LogToIrc.notice This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot's logs to IRC will be sent via NOTICE instead of PRIVMSG. Channels will always be PRIVMSGed, regardless of this variable; NOTICEs will only be used if this variable is True and the target is a nick, not a channel. +.. _conf-supybot.plugins.LogToIrc.public: + supybot.plugins.LogToIrc.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.LogToIrc.targets: + supybot.plugins.LogToIrc.targets This config variable defaults to " ", is network-specific, and is not channel-specific. Determines which channels/nicks the bot should log to. If no channels/nicks are set, this plugin will effectively be turned off. +.. _conf-supybot.plugins.LogToIrc.userCapabilityRequired: + supybot.plugins.LogToIrc.userCapabilityRequired This config variable defaults to "owner", is not network-specific, and is not channel-specific. diff --git a/plugins/Math/README.rst b/plugins/Math/README.rst index c0310afe7..9c4562d6a 100644 --- a/plugins/Math/README.rst +++ b/plugins/Math/README.rst @@ -17,38 +17,43 @@ a unit converter. Commands -------- -.. _command-Math-base: +.. _command-math-base: base [] Converts from base to base . If is left out, it converts to decimal. -.. _command-Math-calc: +.. _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: +.. _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: +.. _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: +.. _command-math-rpn: rpn Returns the value of an RPN expression. -.. _command-Math-units: +.. _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. +.. _conf-Math: + Configuration ------------- + +.. _conf-supybot.plugins.Math.public: + supybot.plugins.Math.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/MessageParser/README.rst b/plugins/MessageParser/README.rst index 3813075dd..d21706337 100644 --- a/plugins/MessageParser/README.rst +++ b/plugins/MessageParser/README.rst @@ -22,93 +22,114 @@ Use 'add' command to add regexp trigger, 'remove' to remove. Commands -------- -.. _command-MessageParser-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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. +.. _conf-MessageParser: + Configuration ------------- + +.. _conf-supybot.plugins.MessageParser.enable: + supybot.plugins.MessageParser.enable This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the message parser is enabled. If enabled, will trigger on regexps added to the regexp db. +.. _conf-supybot.plugins.MessageParser.enableForNotices: + supybot.plugins.MessageParser.enableForNotices This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the message parser is enabled for NOTICE messages too. +.. _conf-supybot.plugins.MessageParser.keepRankInfo: + supybot.plugins.MessageParser.keepRankInfo This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether we keep updating the usage count for each regexp, for popularity ranking. +.. _conf-supybot.plugins.MessageParser.listSeparator: + supybot.plugins.MessageParser.listSeparator This config variable defaults to ", ", is network-specific, and is channel-specific. Determines the separator used between regexps when shown by the list command. +.. _conf-supybot.plugins.MessageParser.maxTriggers: + supybot.plugins.MessageParser.maxTriggers This config variable defaults to "0", is network-specific, and is channel-specific. Determines the maximum number of triggers in one message. Set this to 0 to allow an infinite number of triggers. +.. _conf-supybot.plugins.MessageParser.public: + supybot.plugins.MessageParser.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.MessageParser.rankListLength: + supybot.plugins.MessageParser.rankListLength This config variable defaults to "20", is network-specific, and is channel-specific. Determines the number of regexps returned by the triggerrank command. +.. _conf-supybot.plugins.MessageParser.requireManageCapability: + supybot.plugins.MessageParser.requireManageCapability This config variable defaults to "admin; channel,op", is network-specific, and is channel-specific. Determines the capabilities required (if any) to manage the regexp database, including add, remove, lock, unlock. Use 'channel,capab' for channel-level capabilities. Note that absence of an explicit anticapability means user has capability. +.. _conf-supybot.plugins.MessageParser.requireVacuumCapability: + supybot.plugins.MessageParser.requireVacuumCapability This config variable defaults to "admin", is network-specific, and is channel-specific. diff --git a/plugins/Misc/README.rst b/plugins/Misc/README.rst index 523e46f8a..52338c5b5 100644 --- a/plugins/Misc/README.rst +++ b/plugins/Misc/README.rst @@ -16,93 +16,108 @@ Supybot plugin that should not be removed! Commands -------- -.. _command-Misc-apropos: +.. _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: +.. _command-misc-clearmores: clearmores takes no arguments Clears all mores for the current network. -.. _command-Misc-completenick: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-misc-noticetell: noticetell Tells the whatever is, in a notice. Use nested commands to your benefit here. -.. _command-Misc-ping: +.. _command-misc-ping: ping takes no arguments Checks to see if the bot is alive. -.. _command-Misc-source: +.. _command-misc-source: source takes no arguments Returns a URL saying where to get Limnoria. -.. _command-Misc-tell: +.. _command-misc-tell: tell Tells the whatever is. Use nested commands to your benefit here. -.. _command-Misc-version: +.. _command-misc-version: version takes no arguments Returns the version of the current bot. +.. _conf-Misc: + Configuration ------------- + +.. _conf-supybot.plugins.Misc.customHelpString: + supybot.plugins.Misc.customHelpString This config variable defaults to "", is not network-specific, and is not channel-specific. Sets a custom help string, displayed when the 'help' command is called without arguments. +.. _conf-supybot.plugins.Misc.listPrivatePlugins: + supybot.plugins.Misc.listPrivatePlugins This config variable defaults to "False", is not network-specific, and is not channel-specific. Determines whether the bot will list private plugins with the list command if given the --private switch. If this is disabled, non-owner users should be unable to see what private plugins are loaded. +.. _conf-supybot.plugins.Misc.listUnloadedPlugins: + supybot.plugins.Misc.listUnloadedPlugins This config variable defaults to "False", is not network-specific, and is not channel-specific. Determines whether the bot will list unloaded plugins with the list command if given the --unloaded switch. If this is disabled, non-owner users should be unable to see what unloaded plugins are available. +.. _conf-supybot.plugins.Misc.mores: + supybot.plugins.Misc.mores This config variable defaults to "1", is network-specific, and is channel-specific. Determines how many messages the bot will issue when using the 'more' command. +.. _conf-supybot.plugins.Misc.public: + supybot.plugins.Misc.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Misc.timestampFormat: + supybot.plugins.Misc.timestampFormat This config variable defaults to "[%H:%M:%S]", is not network-specific, and is not channel-specific. diff --git a/plugins/MoobotFactoids/README.rst b/plugins/MoobotFactoids/README.rst index 934d61e38..5e006482e 100644 --- a/plugins/MoobotFactoids/README.rst +++ b/plugins/MoobotFactoids/README.rst @@ -29,68 +29,77 @@ If you want the bot to use /mes with Factoids, that is possible too. Commands -------- -.. _command-MoobotFactoids-factinfo: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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. +.. _conf-MoobotFactoids: + Configuration ------------- + +.. _conf-supybot.plugins.MoobotFactoids.mostCount: + supybot.plugins.MoobotFactoids.mostCount This config variable defaults to "10", is network-specific, and is channel-specific. Determines how many items are shown when the 'most' command is called. +.. _conf-supybot.plugins.MoobotFactoids.public: + supybot.plugins.MoobotFactoids.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch: + supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/Network/README.rst b/plugins/Network/README.rst index 9db6a2a2d..298e6d642 100644 --- a/plugins/Network/README.rst +++ b/plugins/Network/README.rst @@ -18,68 +18,73 @@ and checking latency to the server. Commands -------- -.. _command-Network-capabilities: +.. _command-network-capabilities: capabilities [] Returns the list of IRCv3 capabilities available on the network. -.. _command-Network-cmdall: +.. _command-network-cmdall: cmdall [ ...] Perform (with its associated s) on all networks. -.. _command-Network-command: +.. _command-network-command: command [ ...] Gives the bot (with its associated s) on . -.. _command-Network-connect: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-network-uptime: uptime [] Returns the time duration since the connection was established. -.. _command-Network-whois: +.. _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: +.. _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. +.. _conf-Network: + Configuration ------------- + +.. _conf-supybot.plugins.Network.public: + supybot.plugins.Network.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/News/README.rst b/plugins/News/README.rst index feb20ae5b..ca7c17d10 100644 --- a/plugins/News/README.rst +++ b/plugins/News/README.rst @@ -17,33 +17,38 @@ This plugin provides a means of maintaining News for a channel. Commands -------- -.. _command-News-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-news-remove: remove [] Removes the news item with from . is only necessary if the message isn't sent in the channel itself. +.. _conf-News: + Configuration ------------- + +.. _conf-supybot.plugins.News.public: + supybot.plugins.News.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/NickAuth/README.rst b/plugins/NickAuth/README.rst index 7ef784837..bec46e39b 100644 --- a/plugins/NickAuth/README.rst +++ b/plugins/NickAuth/README.rst @@ -20,28 +20,33 @@ identify to the bot. Commands -------- -.. _command-NickAuth-auth: +.. _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: +.. _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: +.. _command-nickauth-nick.list: nick list [] [] Lists nicks of the on the network. defaults to the current network. -.. _command-NickAuth-nick.remove: +.. _command-nickauth-nick.remove: nick remove [] Remove from the list of nicks owned by the on the . defaults to the current network. +.. _conf-NickAuth: + Configuration ------------- + +.. _conf-supybot.plugins.NickAuth.public: + supybot.plugins.NickAuth.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/NickCapture/README.rst b/plugins/NickCapture/README.rst index 1770bd642..0883c5353 100644 --- a/plugins/NickCapture/README.rst +++ b/plugins/NickCapture/README.rst @@ -14,18 +14,27 @@ This plugin constantly tries to take whatever nick is configured as supybot.nick. Just make sure that's set appropriately, and thus plugin will do the rest. +.. _conf-NickCapture: + Configuration ------------- + +.. _conf-supybot.plugins.NickCapture.ison: + supybot.plugins.NickCapture.ison This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether the bot will check occasionally if its preferred nick is in use via the ISON command. +.. _conf-supybot.plugins.NickCapture.ison.period: + supybot.plugins.NickCapture.ison.period This config variable defaults to "600", is not network-specific, and is not channel-specific. Determines how often (in seconds) the bot will check whether its nick ISON. +.. _conf-supybot.plugins.NickCapture.public: + supybot.plugins.NickCapture.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Nickometer/README.rst b/plugins/Nickometer/README.rst index 41d1b5943..3c501c3b3 100644 --- a/plugins/Nickometer/README.rst +++ b/plugins/Nickometer/README.rst @@ -17,13 +17,18 @@ Will tell you how lame a nick is by the command 'nickometer [nick]'. Commands -------- -.. _command-Nickometer-nickometer: +.. _command-nickometer-nickometer: nickometer [] Tells you how lame said nick is. If is not given, uses the nick of the person giving the command. +.. _conf-Nickometer: + Configuration ------------- + +.. _conf-supybot.plugins.Nickometer.public: + supybot.plugins.Nickometer.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Note/README.rst b/plugins/Note/README.rst index 274c966c0..3e8b6fcbc 100644 --- a/plugins/Note/README.rst +++ b/plugins/Note/README.rst @@ -16,43 +16,48 @@ Allows you to send notes to other users. Commands -------- -.. _command-Note-list: +.. _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: +.. _command-note-next: next takes no arguments Retrieves your next unread note, if any. -.. _command-Note-note: +.. _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: +.. _command-note-reply: reply Sends a note in reply to . -.. _command-Note-search: +.. _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: +.. _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: +.. _command-note-unsend: unsend Unsends the note with the id given. You must be the author of the note, and it must be unread. +.. _conf-Note: + Configuration ------------- + +.. _conf-supybot.plugins.Note.public: + supybot.plugins.Note.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Owner/README.rst b/plugins/Owner/README.rst index 5c7916296..af1ec7f96 100644 --- a/plugins/Owner/README.rst +++ b/plugins/Owner/README.rst @@ -17,98 +17,107 @@ that should not be removed! Commands -------- -.. _command-Owner-announce: +.. _command-owner-announce: announce Sends to all channels the bot is currently on and not lobotomized in. -.. _command-Owner-defaultcapability: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-owner-ircquote: ircquote Sends the raw string given to the server. -.. _command-Owner-load: +.. _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: +.. _command-owner-logmark: logmark Logs to the global Supybot log at critical priority. Useful for marking logfiles for later searching. -.. _command-Owner-quit: +.. _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: +.. _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: +.. _command-owner-reloadlocale: reloadlocale takes no argument Reloads the locale of the bot. -.. _command-Owner-rename: +.. _command-owner-rename: rename Renames in to the . -.. _command-Owner-unload: +.. _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: +.. _command-owner-unrename: unrename Removes all renames in . The plugin will be reloaded after this command is run. -.. _command-Owner-upkeep: +.. _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). +.. _conf-Owner: + Configuration ------------- + +.. _conf-supybot.plugins.Owner.announceFormat: + supybot.plugins.Owner.announceFormat This config variable defaults to "Announcement from my owner ($owner): $text", is not network-specific, and is not channel-specific. Determines the format of messages sent by the 'announce' command. $owner may be used for the username of the owner calling this command, and $text for the announcement being made. +.. _conf-supybot.plugins.Owner.public: + supybot.plugins.Owner.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Owner.quitMsg: + supybot.plugins.Owner.quitMsg This config variable defaults to "Limnoria $version", is not network-specific, and is not channel-specific. diff --git a/plugins/Plugin/README.rst b/plugins/Plugin/README.rst index ef2453c21..07e958ec1 100644 --- a/plugins/Plugin/README.rst +++ b/plugins/Plugin/README.rst @@ -19,33 +19,38 @@ command exists in. Commands -------- -.. _command-Plugin-author: +.. _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: +.. _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: +.. _command-plugin-help: help Returns a useful description of how to use , if the plugin has one. -.. _command-Plugin-plugin: +.. _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: +.. _command-plugin-plugins: plugins Returns the names of all plugins that contain . +.. _conf-Plugin: + Configuration ------------- + +.. _conf-supybot.plugins.Plugin.public: + supybot.plugins.Plugin.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/PluginDownloader/README.rst b/plugins/PluginDownloader/README.rst index 4cbb2a919..6b6aa9454 100644 --- a/plugins/PluginDownloader/README.rst +++ b/plugins/PluginDownloader/README.rst @@ -53,23 +53,28 @@ Examples Commands -------- -.. _command-PluginDownloader-info: +.. _command-plugindownloader-info: info Displays informations on the in the . -.. _command-PluginDownloader-install: +.. _command-plugindownloader-install: install Downloads and installs the from the . -.. _command-PluginDownloader-repolist: +.. _command-plugindownloader-repolist: repolist [] Displays the list of plugins in the . If is not given, returns a list of available repositories. +.. _conf-PluginDownloader: + Configuration ------------- + +.. _conf-supybot.plugins.PluginDownloader.public: + supybot.plugins.PluginDownloader.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Praise/README.rst b/plugins/Praise/README.rst index 977efa23f..b7f1e10b8 100644 --- a/plugins/Praise/README.rst +++ b/plugins/Praise/README.rst @@ -24,48 +24,55 @@ Example: Commands -------- -.. _command-Praise-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-praise-search: search [] [--{regexp,by} ] [] Searches for praises matching the criteria given. -.. _command-Praise-stats: +.. _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. +.. _conf-Praise: + Configuration ------------- + +.. _conf-supybot.plugins.Praise.public: + supybot.plugins.Praise.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Praise.showIds: + supybot.plugins.Praise.showIds This config variable defaults to "False", is network-specific, and is channel-specific. diff --git a/plugins/Protector/README.rst b/plugins/Protector/README.rst index b14af8e88..07dd41f30 100644 --- a/plugins/Protector/README.rst +++ b/plugins/Protector/README.rst @@ -13,18 +13,27 @@ Usage Prevents users from doing things they are not supposed to do on a channel, even if they have +o or +h. +.. _conf-Protector: + Configuration ------------- + +.. _conf-supybot.plugins.Protector.enable: + supybot.plugins.Protector.enable This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether this plugin is enabled in a given channel. +.. _conf-supybot.plugins.Protector.immune: + supybot.plugins.Protector.immune This config variable defaults to " ", is network-specific, and is channel-specific. Determines what nicks the bot will consider to be immune from enforcement. These nicks will not even have their actions watched by this plugin. In general, only the ChanServ for this network will be in this list. +.. _conf-supybot.plugins.Protector.public: + supybot.plugins.Protector.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Quote/README.rst b/plugins/Quote/README.rst index b42b6d4cd..a08afa5bc 100644 --- a/plugins/Quote/README.rst +++ b/plugins/Quote/README.rst @@ -15,48 +15,53 @@ This plugin allows you to add quotes to the database for a channel. Commands -------- -.. _command-Quote-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-quote-replace: replace [] Replace quote with . is only necessary if the message isn't sent in the channel itself. -.. _command-Quote-search: +.. _command-quote-search: search [] [--{regexp,by} ] [] Searches for quotes matching the criteria given. -.. _command-Quote-stats: +.. _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. +.. _conf-Quote: + Configuration ------------- + +.. _conf-supybot.plugins.Quote.public: + supybot.plugins.Quote.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/QuoteGrabs/README.rst b/plugins/QuoteGrabs/README.rst index 1eabc0041..09039bda7 100644 --- a/plugins/QuoteGrabs/README.rst +++ b/plugins/QuoteGrabs/README.rst @@ -20,68 +20,81 @@ and/or on user request. Commands -------- -.. _command-QuoteGrabs-get: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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. +.. _conf-QuoteGrabs: + Configuration ------------- + +.. _conf-supybot.plugins.QuoteGrabs.public: + supybot.plugins.QuoteGrabs.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.QuoteGrabs.randomGrabber: + supybot.plugins.QuoteGrabs.randomGrabber This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will randomly grab possibly-suitable quotes on occasion. The suitability of a given message is determined by ... +.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs: + supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs This config variable defaults to "864000", is network-specific, and is channel-specific. Determines about how many seconds, on average, should elapse between random grabs. This is only an average value; grabs can happen from any time after half this time until never, although that's unlikely to occur. +.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters: + supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters This config variable defaults to "8", is network-specific, and is channel-specific. Determines the minimum number of characters in a message for it to be considered for random grabbing. +.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.minimumWords: + supybot.plugins.QuoteGrabs.randomGrabber.minimumWords This config variable defaults to "3", is network-specific, and is channel-specific. diff --git a/plugins/RSS/README.rst b/plugins/RSS/README.rst index 1f30841a4..917b5ecff 100644 --- a/plugins/RSS/README.rst +++ b/plugins/RSS/README.rst @@ -54,113 +54,144 @@ and understand what it says and then you can do Commands -------- -.. _command-RSS-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-rss-remove: remove Removes the command for looking up RSS feeds at from this plugin. -.. _command-RSS-rss: +.. _command-rss-rss: rss [] Gets the title components of the given RSS feed. If is given, return only that many headlines. +.. _conf-RSS: + Configuration ------------- + +.. _conf-supybot.plugins.RSS.announce: + supybot.plugins.RSS.announce This config variable defaults to " ", is network-specific, and is channel-specific. Determines which RSS feeds should be announced in the channel; valid input is a list of strings (either registered RSS feeds or RSS feed URLs) separated by spaces. +.. _conf-supybot.plugins.RSS.announceFormat: + supybot.plugins.RSS.announceFormat This config variable defaults to "News from $feed_name: $title <$link>", is network-specific, and is channel-specific. The format the bot will use for displaying headlines of a RSS feed that is announced. See supybot.plugins.RSS.format for the available variables. +.. _conf-supybot.plugins.RSS.defaultNumberOfHeadlines: + supybot.plugins.RSS.defaultNumberOfHeadlines This config variable defaults to "1", is network-specific, and is channel-specific. Indicates how many headlines an rss feed will output by default, if no number is provided. +.. _conf-supybot.plugins.RSS.feeds: + supybot.plugins.RSS.feeds This config variable defaults to " ", is not network-specific, and is not channel-specific. Determines what feeds should be accessible as commands. +.. _conf-supybot.plugins.RSS.format: + supybot.plugins.RSS.format This config variable defaults to "$date: $title <$link>", is network-specific, and is channel-specific. The format the bot will use for displaying headlines of a RSS feed that is triggered manually. In addition to fields defined by feedparser ($published (the entry date), $title, $link, $description, $id, etc.), the following variables can be used: $feed_name, $date (parsed date, as defined in supybot.reply.format.time) +.. _conf-supybot.plugins.RSS.headlineSeparator: + supybot.plugins.RSS.headlineSeparator This config variable defaults to " | ", is network-specific, and is channel-specific. Determines what string is used to separate headlines in new feeds. +.. _conf-supybot.plugins.RSS.initialAnnounceHeadlines: + supybot.plugins.RSS.initialAnnounceHeadlines This config variable defaults to "5", is network-specific, and is channel-specific. Indicates how many headlines an rss feed will output when it is first added to announce for a channel. +.. _conf-supybot.plugins.RSS.keywordBlacklist: + supybot.plugins.RSS.keywordBlacklist This config variable defaults to " ", is network-specific, and is channel-specific. Space separated list of strings, lets you filter headlines to those not containing any items in this blacklist. +.. _conf-supybot.plugins.RSS.keywordWhitelist: + supybot.plugins.RSS.keywordWhitelist This config variable defaults to " ", is network-specific, and is channel-specific. Space separated list of strings, lets you filter headlines to those containing one or more items in this whitelist. +.. _conf-supybot.plugins.RSS.maximumAnnounceHeadlines: + supybot.plugins.RSS.maximumAnnounceHeadlines This config variable defaults to "5", is network-specific, and is channel-specific. Indicates how many new news entries may be sent at the same time. Extra entries will be discarded. +.. _conf-supybot.plugins.RSS.notice: + supybot.plugins.RSS.notice This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether announces will be sent as notices instead of privmsgs. +.. _conf-supybot.plugins.RSS.public: + supybot.plugins.RSS.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.RSS.sortFeedItems: + supybot.plugins.RSS.sortFeedItems This config variable defaults to "asInFeed", is not network-specific, and is not channel-specific. Determines whether feed items should be sorted by their publication/update timestamp or kept in the same order as they appear in a feed. Valid strings: asInFeed, oldestFirst, newestFirst, outdatedFirst, and updatedFirst. +.. _conf-supybot.plugins.RSS.waitPeriod: + supybot.plugins.RSS.waitPeriod This config variable defaults to "1800", is not network-specific, and is not channel-specific. diff --git a/plugins/Relay/README.rst b/plugins/Relay/README.rst index 81dd0538f..017257d09 100644 --- a/plugins/Relay/README.rst +++ b/plugins/Relay/README.rst @@ -24,68 +24,91 @@ https://limnoria.net/plugins.xhtml#messaging Commands -------- -.. _command-Relay-join: +.. _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: +.. _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: +.. _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. +.. _conf-Relay: + Configuration ------------- + +.. _conf-supybot.plugins.Relay.channels: + supybot.plugins.Relay.channels This config variable defaults to " ", is not network-specific, and is not channel-specific. Determines which channels the bot will relay in. +.. _conf-supybot.plugins.Relay.channels.joinOnAllNetworks: + supybot.plugins.Relay.channels.joinOnAllNetworks This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will always join the channel(s) it relays when connecting to any network. +.. _conf-supybot.plugins.Relay.color: + supybot.plugins.Relay.color This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will color relayed PRIVMSGs so as to make the messages easier to read. +.. _conf-supybot.plugins.Relay.hostmasks: + supybot.plugins.Relay.hostmasks This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will relay the hostmask of the person joining or parting the channel when they join or part. +.. _conf-supybot.plugins.Relay.ignores: + supybot.plugins.Relay.ignores This config variable defaults to " ", is network-specific, and is channel-specific. Determines what hostmasks will not be relayed on a channel. +.. _conf-supybot.plugins.Relay.includeNetwork: + supybot.plugins.Relay.includeNetwork This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will include the network in relayed PRIVMSGs; if you're only relaying between two networks, it's somewhat redundant, and you may wish to save the space. +.. _conf-supybot.plugins.Relay.noticeNonPrivmsgs: + supybot.plugins.Relay.noticeNonPrivmsgs This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will used NOTICEs rather than PRIVMSGs for non-PRIVMSG relay messages (i.e., joins, parts, nicks, quits, modes, etc.) +.. _conf-supybot.plugins.Relay.public: + supybot.plugins.Relay.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Relay.punishOtherRelayBots: + supybot.plugins.Relay.punishOtherRelayBots This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will detect other bots relaying and respond by kickbanning them. +.. _conf-supybot.plugins.Relay.topicSync: + supybot.plugins.Relay.topicSync This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/Reply/README.rst b/plugins/Reply/README.rst index 63e5d42ad..e35edbb0c 100644 --- a/plugins/Reply/README.rst +++ b/plugins/Reply/README.rst @@ -18,33 +18,38 @@ can be easily abused. Commands -------- -.. _command-Reply-action: +.. _command-reply-action: action Replies with as an action. Use nested commands to your benefit here. -.. _command-Reply-notice: +.. _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: +.. _command-reply-private: private Replies with in private. Use nested commands to your benefit here. -.. _command-Reply-replies: +.. _command-reply-replies: replies [ ...] Replies with each of its arguments in separate replies, depending the configuration of supybot.reply.oneToOne. -.. _command-Reply-reply: +.. _command-reply-reply: reply Replies with . Equivalent to the alias, 'echo $nick: $1'. +.. _conf-Reply: + Configuration ------------- + +.. _conf-supybot.plugins.Reply.public: + supybot.plugins.Reply.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Scheduler/README.rst b/plugins/Scheduler/README.rst index f3bf5c170..fbbe1130c 100644 --- a/plugins/Scheduler/README.rst +++ b/plugins/Scheduler/README.rst @@ -18,33 +18,38 @@ This plugin allows you to schedule commands to execute at a later time. Commands -------- -.. _command-Scheduler-add: +.. _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: +.. _command-scheduler-list: list takes no arguments Lists the currently scheduled events. -.. _command-Scheduler-remind: +.. _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: +.. _command-scheduler-remove: remove Removes the event scheduled with id from the schedule. -.. _command-Scheduler-repeat: +.. _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. +.. _conf-Scheduler: + Configuration ------------- + +.. _conf-supybot.plugins.Scheduler.public: + supybot.plugins.Scheduler.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/SedRegex/README.rst b/plugins/SedRegex/README.rst index ce340f307..1743861f5 100644 --- a/plugins/SedRegex/README.rst +++ b/plugins/SedRegex/README.rst @@ -36,33 +36,48 @@ supported: - ``s``: *(custom flag specific to this plugin)* replace only messages from the caller +.. _conf-SedRegex: + Configuration ------------- + +.. _conf-supybot.plugins.SedRegex.boldReplacementText: + supybot.plugins.SedRegex.boldReplacementText This config variable defaults to "True", is network-specific, and is channel-specific. Should the replacement text be bolded? +.. _conf-supybot.plugins.SedRegex.displayErrors: + supybot.plugins.SedRegex.displayErrors This config variable defaults to "True", is network-specific, and is channel-specific. Should errors be displayed? +.. _conf-supybot.plugins.SedRegex.enable: + supybot.plugins.SedRegex.enable This config variable defaults to "False", is network-specific, and is channel-specific. Should Perl/sed-style regex replacing work in this channel? +.. _conf-supybot.plugins.SedRegex.ignoreRegex: + supybot.plugins.SedRegex.ignoreRegex This config variable defaults to "True", is network-specific, and is channel-specific. Should Perl/sed regex replacing ignore messages which look like valid regex? +.. _conf-supybot.plugins.SedRegex.processTimeout: + supybot.plugins.SedRegex.processTimeout This config variable defaults to "0.5", is not network-specific, and is not channel-specific. Sets the timeout when processing a single regexp. The default should be adequate unless you have a busy or low-powered system that cannot process regexps quickly enough. However, you will not want to set this value too high as that would make your bot vulnerable to ReDoS attacks. +.. _conf-supybot.plugins.SedRegex.public: + supybot.plugins.SedRegex.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Seen/README.rst b/plugins/Seen/README.rst index dc4f919aa..45e841e7b 100644 --- a/plugins/Seen/README.rst +++ b/plugins/Seen/README.rst @@ -18,43 +18,52 @@ what you missed since you left a channel. Commands -------- -.. _command-Seen-any: +.. _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: +.. _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: +.. _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: +.. _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: +.. _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. +.. _conf-Seen: + Configuration ------------- + +.. _conf-supybot.plugins.Seen.minimumNonWildcard: + supybot.plugins.Seen.minimumNonWildcard This config variable defaults to "2", is network-specific, and is channel-specific. The minimum non-wildcard characters required to perform a 'seen' request. Of course, it only applies if there is a wildcard in the request. +.. _conf-supybot.plugins.Seen.public: + supybot.plugins.Seen.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.Seen.showLastMessage: + supybot.plugins.Seen.showLastMessage This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/Services/README.rst b/plugins/Services/README.rst index b5bbe470e..1e25f7585 100644 --- a/plugins/Services/README.rst +++ b/plugins/Services/README.rst @@ -23,108 +23,133 @@ necessary if the bot is properly configured. Commands -------- -.. _command-Services-ghost: +.. _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: +.. _command-services-identify: identify takes no arguments Identifies with NickServ using the current nick. -.. _command-Services-invite: +.. _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: +.. _command-services-nicks: nicks takes no arguments Returns the nicks that this plugin is configured to identify and ghost with. -.. _command-Services-op: +.. _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: +.. _command-services-password: password [] Sets the NickServ password for to . If is not given, removes from the configured nicks. -.. _command-Services-register: +.. _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: +.. _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: +.. _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: +.. _command-services-voice: voice [] Attempts to get voiced by ChanServ in . is only necessary if the message isn't sent in the channel itself. +.. _conf-Services: + Configuration ------------- + +.. _conf-supybot.plugins.Services.ChanServ: + supybot.plugins.Services.ChanServ This config variable defaults to "ChanServ", is network-specific, and is not channel-specific. Determines what nick the 'ChanServ' service has. +.. _conf-supybot.plugins.Services.ChanServ.halfop: + supybot.plugins.Services.ChanServ.halfop This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will request to get half-opped by the ChanServ when it joins the channel. +.. _conf-supybot.plugins.Services.ChanServ.op: + supybot.plugins.Services.ChanServ.op This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will request to get opped by the ChanServ when it joins the channel. +.. _conf-supybot.plugins.Services.ChanServ.password: + supybot.plugins.Services.ChanServ.password This config variable defaults to "", is network-specific, and is channel-specific. Determines what password the bot will use with ChanServ. +.. _conf-supybot.plugins.Services.ChanServ.voice: + supybot.plugins.Services.ChanServ.voice This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will request to get voiced by the ChanServ when it joins the channel. +.. _conf-supybot.plugins.Services.NickServ: + supybot.plugins.Services.NickServ This config variable defaults to "NickServ", is network-specific, and is not channel-specific. Determines what nick the 'NickServ' service has. +.. _conf-supybot.plugins.Services.disabledNetworks: + supybot.plugins.Services.disabledNetworks This config variable defaults to "QuakeNet", is not network-specific, and is not channel-specific. Determines what networks this plugin will be disabled on. +.. _conf-supybot.plugins.Services.ghostDelay: + supybot.plugins.Services.ghostDelay This config variable defaults to "60", is network-specific, and is not channel-specific. Determines how many seconds the bot will wait between successive GHOST attempts. Set this to 0 to disable GHOST. +.. _conf-supybot.plugins.Services.nicks: + supybot.plugins.Services.nicks This config variable defaults to " ", is network-specific, and is not channel-specific. Determines what nicks the bot will use with services. +.. _conf-supybot.plugins.Services.noJoinsUntilIdentified: + supybot.plugins.Services.noJoinsUntilIdentified This config variable defaults to "False", is network-specific, and is not channel-specific. Determines whether the bot will not join any channels until it is identified. This may be useful, for instances, if you have a vhost that isn't set until you're identified, or if you're joining +r channels that won't allow you to join unless you identify. +.. _conf-supybot.plugins.Services.public: + supybot.plugins.Services.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/ShrinkUrl/README.rst b/plugins/ShrinkUrl/README.rst index 33ce41d93..9a8887000 100644 --- a/plugins/ShrinkUrl/README.rst +++ b/plugins/ShrinkUrl/README.rst @@ -16,63 +16,84 @@ like tinyurl. Commands -------- -.. _command-ShrinkUrl-tiny: +.. _command-shrinkurl-tiny: tiny Returns a TinyURL.com version of -.. _command-ShrinkUrl-ur1: +.. _command-shrinkurl-ur1: ur1 Returns an ur1 version of . -.. _command-ShrinkUrl-x0: +.. _command-shrinkurl-x0: x0 Returns an x0.no version of . +.. _conf-ShrinkUrl: + Configuration ------------- + +.. _conf-supybot.plugins.ShrinkUrl.bold: + supybot.plugins.ShrinkUrl.bold This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin will bold certain portions of its replies. +.. _conf-supybot.plugins.ShrinkUrl.default: + supybot.plugins.ShrinkUrl.default This config variable defaults to "x0", is network-specific, and is channel-specific. Determines what website the bot will use when shrinking a URL. Valid strings: tiny, ur1, and x0. +.. _conf-supybot.plugins.ShrinkUrl.minimumLength: + supybot.plugins.ShrinkUrl.minimumLength This config variable defaults to "48", is network-specific, and is channel-specific. The minimum length a URL must be before the bot will shrink it. +.. _conf-supybot.plugins.ShrinkUrl.nonSnarfingRegexp: + supybot.plugins.ShrinkUrl.nonSnarfingRegexp This config variable defaults to "", is network-specific, and is channel-specific. Determines what URLs are to be snarfed; URLs matching the regexp given will not be snarfed. Give the empty string if you have no URLs that you'd like to exclude from being snarfed. +.. _conf-supybot.plugins.ShrinkUrl.outFilter: + supybot.plugins.ShrinkUrl.outFilter This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the bot will shrink the URLs of outgoing messages if those URLs are longer than supybot.plugins.ShrinkUrl.minimumLength. +.. _conf-supybot.plugins.ShrinkUrl.public: + supybot.plugins.ShrinkUrl.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible. +.. _conf-supybot.plugins.ShrinkUrl.serviceRotation: + supybot.plugins.ShrinkUrl.serviceRotation This config variable defaults to " ", is network-specific, and is channel-specific. If set to a non-empty value, specifies the list of services to rotate through for the shrinkSnarfer and outFilter. +.. _conf-supybot.plugins.ShrinkUrl.shrinkSnarfer: + supybot.plugins.ShrinkUrl.shrinkSnarfer This config variable defaults to "False", is network-specific, and is channel-specific. Determines whether the shrink snarfer is enabled. This snarfer will watch for URLs in the channel, and if they're sufficiently long (as determined by supybot.plugins.ShrinkUrl.minimumLength) it will post a smaller URL from the service as denoted in supybot.plugins.ShrinkUrl.default. +.. _conf-supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain: + supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain This config variable defaults to "True", is network-specific, and is channel-specific. diff --git a/plugins/Status/README.rst b/plugins/Status/README.rst index 66823fb9f..f0a767bf1 100644 --- a/plugins/Status/README.rst +++ b/plugins/Status/README.rst @@ -17,58 +17,63 @@ uptime. Commands -------- -.. _command-Status-cmd: +.. _command-status-cmd: cmd takes no arguments Returns some interesting command-related statistics. -.. _command-Status-commands: +.. _command-status-commands: commands takes no arguments Returns a list of the commands offered by the bot. -.. _command-Status-cpu: +.. _command-status-cpu: cpu takes no arguments Returns some interesting CPU-related statistics on the bot. -.. _command-Status-net: +.. _command-status-net: net takes no arguments Returns some interesting network-related statistics. -.. _command-Status-network: +.. _command-status-network: network takes no arguments Returns the network the bot is on. -.. _command-Status-processes: +.. _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: +.. _command-status-server: server takes no arguments Returns the server the bot is on. -.. _command-Status-status: +.. _command-status-status: status takes no arguments Returns the status of the bot. -.. _command-Status-threads: +.. _command-status-threads: threads takes no arguments Returns the current threads that are active. -.. _command-Status-uptime: +.. _command-status-uptime: uptime takes no arguments Returns the amount of time the bot has been running. +.. _conf-Status: + Configuration ------------- + +.. _conf-supybot.plugins.Status.public: + supybot.plugins.Status.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/String/README.rst b/plugins/String/README.rst index d4834dbd6..da156d428 100644 --- a/plugins/String/README.rst +++ b/plugins/String/README.rst @@ -15,73 +15,78 @@ Provides useful commands for manipulating characters and strings. Commands -------- -.. _command-String-chr: +.. _command-string-chr: chr Returns the unicode character associated with codepoint -.. _command-String-decode: +.. _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: +.. _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: +.. _command-string-len: len Returns the length of . -.. _command-String-levenshtein: +.. _command-string-levenshtein: levenshtein Returns the levenshtein distance (also known as the "edit distance" between and ) -.. _command-String-md5: +.. _command-string-md5: md5 Returns the md5 hash of a given string. -.. _command-String-ord: +.. _command-string-ord: ord Returns the unicode codepoint of . -.. _command-String-re: +.. _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: +.. _command-string-sha: sha Returns the SHA1 hash of a given string. -.. _command-String-soundex: +.. _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: +.. _command-string-unicodename: unicodename Returns the name of the given unicode . -.. _command-String-unicodesearch: +.. _command-string-unicodesearch: unicodesearch Searches for a unicode character from its . -.. _command-String-xor: +.. _command-string-xor: xor Returns XOR-encrypted with . +.. _conf-String: + Configuration ------------- + +.. _conf-supybot.plugins.String.public: + supybot.plugins.String.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Success/README.rst b/plugins/Success/README.rst index 69ad0ebd7..60168f285 100644 --- a/plugins/Success/README.rst +++ b/plugins/Success/README.rst @@ -21,43 +21,50 @@ responses. Commands -------- -.. _command-Success-add: +.. _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: +.. _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: +.. _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: +.. _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: +.. _command-success-search: search [] [--{regexp,by} ] [] Searches for successes matching the criteria given. -.. _command-Success-stats: +.. _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. +.. _conf-Success: + Configuration ------------- + +.. _conf-supybot.plugins.Success.prefixNick: + supybot.plugins.Success.prefixNick This config variable defaults to "True", is network-specific, and is channel-specific. Determines whether the bot will prefix the nick of the user giving an invalid command to the success response. +.. _conf-supybot.plugins.Success.public: + supybot.plugins.Success.public This config variable defaults to "True", is not network-specific, and is not channel-specific. diff --git a/plugins/Time/README.rst b/plugins/Time/README.rst index 95ee9b55c..97f5b28e8 100644 --- a/plugins/Time/README.rst +++ b/plugins/Time/README.rst @@ -15,53 +15,60 @@ This plugin allows you to use different time-related functions. Commands -------- -.. _command-Time-at: +.. _command-time-at: at [