From b42596a0214cddfe8ff73daa8ac00cf64e52bb81 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Thu, 12 Jan 2023 22:24:04 +0100 Subject: [PATCH] Regenerate READMEs --- plugins/BadWords/README.rst | 8 ++++++++ plugins/Channel/README.rst | 6 +++--- plugins/Config/README.rst | 2 +- plugins/Google/README.rst | 20 -------------------- plugins/MoobotFactoids/README.rst | 13 ++++++++++++- plugins/Poll/README.rst | 5 +++++ plugins/Services/README.rst | 10 +++++++++- plugins/String/README.rst | 8 ++++---- 8 files changed, 42 insertions(+), 30 deletions(-) diff --git a/plugins/BadWords/README.rst b/plugins/BadWords/README.rst index d52ab11b4..e6636d078 100644 --- a/plugins/BadWords/README.rst +++ b/plugins/BadWords/README.rst @@ -99,6 +99,14 @@ supybot.plugins.BadWords.requireWordBoundaries 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.selfCensor: + + +supybot.plugins.BadWords.selfCensor + This config variable defaults to "True", is network-specific, and is channel-specific. + + Determines whether the bot will filter its own messages. + .. _conf-supybot.plugins.BadWords.simpleReplacement: diff --git a/plugins/Channel/README.rst b/plugins/Channel/README.rst index 1e16a12d1..ba49124b6 100644 --- a/plugins/Channel/README.rst +++ b/plugins/Channel/README.rst @@ -114,7 +114,7 @@ halfop [] [ ...] .. _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. + 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 --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: @@ -138,8 +138,8 @@ invite [] .. _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. +kban [] [--{exact,nick,user,host,account}] [] [] + 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 the --nick, --user, and --host options as you choose. is only necessary if the message isn't sent in the channel itself. .. _command-channel-key: diff --git a/plugins/Config/README.rst b/plugins/Config/README.rst index 2c4a430a8..3cf295fc9 100644 --- a/plugins/Config/README.rst +++ b/plugins/Config/README.rst @@ -47,7 +47,7 @@ help .. _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. + 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 channel-specific, 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 network-specific, it is preceded by a ':' sign. .. _command-config-network: diff --git a/plugins/Google/README.rst b/plugins/Google/README.rst index 5a0233254..b416c9fef 100644 --- a/plugins/Google/README.rst +++ b/plugins/Google/README.rst @@ -43,21 +43,6 @@ Check: `Supported language codes`_ Commands -------- -.. _command-google-cache: - -cache - Returns a link to the cached version of if it is available. - -.. _command-google-calc: - -calc - Uses Google's calculator to calculate the value of . - -.. _command-google-fight: - -fight [ ...] - Returns the results of each search, in order, from greatest number of results to least. - .. _command-google-google: google [--{filter,language} ] @@ -68,11 +53,6 @@ google [--{filter,language} ] lucky [--snippet] Does a google search, but only returns the first result. If option --snippet is given, returns also the page text snippet. -.. _command-google-phonebook: - -phonebook - Looks up on Google. - .. _command-google-translate: translate [to] diff --git a/plugins/MoobotFactoids/README.rst b/plugins/MoobotFactoids/README.rst index 257cabfb0..4ee29606e 100644 --- a/plugins/MoobotFactoids/README.rst +++ b/plugins/MoobotFactoids/README.rst @@ -20,13 +20,24 @@ To add factoid say ``@something is something`` And when you call ``@something`` the bot says ``something is something``. -If you want factoid to be in different format say (for example): +If you want the factoid to be in different format say (for example): ``@Hi is Hello`` And when you call ``@hi`` the bot says ``Hello.`` If you want the bot to use /mes with Factoids, that is possible too. ``@test is tests.`` and everytime when someone calls for ``test`` the bot answers ``* bot tests.`` +If you want the factoid to have random answers say (for example): +``@fruit is (orange|apple|banana)``. So when ``@fruit`` is called +the bot will reply with one of the listed fruits (random): ``orange``. + +If you want to replace the value of the factoid, for example: +``@no Hi is Hey`` when you call ``@hi`` the bot says ``Hey``. + +If you want to append to the current value of a factoid say: +``@Hi is also Hello``, so that when you call ``@hi`` the +bot says ``Hey, or Hello.`` + .. _commands-MoobotFactoids: Commands diff --git a/plugins/Poll/README.rst b/plugins/Poll/README.rst index f7c50aa26..2e1434a49 100644 --- a/plugins/Poll/README.rst +++ b/plugins/Poll/README.rst @@ -61,6 +61,11 @@ add [] [ [ [...]]] close [] Closes the specified poll. +.. _command-poll-list: + +list [] + Lists open polls in the . + .. _command-poll-results: results [] diff --git a/plugins/Services/README.rst b/plugins/Services/README.rst index 6a963ad2a..6a2970777 100644 --- a/plugins/Services/README.rst +++ b/plugins/Services/README.rst @@ -153,6 +153,14 @@ supybot.plugins.Services.disabledNetworks Determines what networks this plugin will be disabled on. +.. _conf-supybot.plugins.Services.ghostCommand: + + +supybot.plugins.Services.ghostCommand + This config variable defaults to "GHOST", is network-specific, and is not channel-specific. + + Determines the NickServ command to use for GHOST. If the network you're using runs Anope, set this to "RECOVER". If the network you're using runs Atheme, set this to "GHOST" or "REGAIN". + .. _conf-supybot.plugins.Services.ghostDelay: @@ -167,7 +175,7 @@ supybot.plugins.Services.ghostDelay 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. + Space-separated list of nicks the bot will use with services. .. _conf-supybot.plugins.Services.noJoinsUntilIdentified: diff --git a/plugins/String/README.rst b/plugins/String/README.rst index f0f1b0dc6..a0c79664e 100644 --- a/plugins/String/README.rst +++ b/plugins/String/README.rst @@ -50,8 +50,8 @@ md5 .. _command-string-ord: -ord - Returns the unicode codepoint of . +ord + Returns the unicode codepoint of characters in . .. _command-string-re: @@ -70,8 +70,8 @@ soundex [] .. _command-string-unicodename: -unicodename - Returns the name of the given unicode . +unicodename + Returns the name of characters in . This will error if any character is not a valid Unicode character. .. _command-string-unicodesearch: