Regenerate READMEs

This commit is contained in:
Valentin Lorentz 2023-01-12 22:24:04 +01:00
parent 02a0204f80
commit b42596a021
8 changed files with 42 additions and 30 deletions

View File

@ -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:

View File

@ -114,7 +114,7 @@ halfop [<channel>] [<nick> ...]
.. _command-channel-iban:
iban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>]
If you have the #channel,op capability, this will ban <nick> for as many seconds as you specify, otherwise (if you specify 0 seconds or don't specify a number of seconds) it will ban the person indefinitely. --exact can be used to specify an exact hostmask. You can combine the exact, nick, user, and host options as you choose. <channel> is only necessary if the message isn't sent in the channel itself.
If you have the #channel,op capability, this will ban <nick> for as many seconds as you specify, otherwise (if you specify 0 seconds or don't specify a number of seconds) it will ban the person indefinitely. --exact can be used to specify an exact hostmask. You can combine the --nick, --user, and --host options as you choose. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-channel-ignore.add:
@ -138,8 +138,8 @@ invite [<channel>] <nick>
.. _command-channel-kban:
kban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>] [<reason>]
If you have the #channel,op capability, this will kickban <nick> for as many seconds as you specify, or else (if you specify 0 seconds or don't specify a number of seconds) it will ban the person indefinitely. --exact bans only the exact hostmask; --nick bans just the nick; --user bans just the user, and --host bans just the host. You can combine these options as you choose. <reason> is a reason to give for the kick. <channel> is only necessary if the message isn't sent in the channel itself.
kban [<channel>] [--{exact,nick,user,host,account}] <nick> [<seconds>] [<reason>]
If you have the #channel,op capability, this will kickban <nick> for as many seconds as you specify, or else (if you specify 0 seconds or don't specify a number of seconds) it will ban the person indefinitely. --exact bans only the exact hostmask; --nick bans just the nick; --user bans just the user, and --host bans just the host You can combine the --nick, --user, and --host options as you choose. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-channel-key:

View File

@ -47,7 +47,7 @@ help <name>
.. _command-config-list:
list <group>
Returns the configuration variables available under the given configuration <group>. If a variable has values under it, it is preceded by an '@' sign. If a variable is a 'ChannelValue', that is, it can be separately configured for each channel using the 'channel' command in this plugin, it is preceded by an '#' sign. And if a variable is a 'NetworkValue', it is preceded by a ':' sign.
Returns the configuration variables available under the given configuration <group>. If a variable has values under it, it is preceded by an '@' sign. If a variable is 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:

View File

@ -43,21 +43,6 @@ Check: `Supported language codes`_
Commands
--------
.. _command-google-cache:
cache <url>
Returns a link to the cached version of <url> if it is available.
.. _command-google-calc:
calc <expression>
Uses Google's calculator to calculate the value of <expression>.
.. _command-google-fight:
fight <search string> <search string> [<search string> ...]
Returns the results of each search, in order, from greatest number of results to least.
.. _command-google-google:
google <search> [--{filter,language} <value>]
@ -68,11 +53,6 @@ google <search> [--{filter,language} <value>]
lucky [--snippet] <search>
Does a google search, but only returns the first result. If option --snippet is given, returns also the page text snippet.
.. _command-google-phonebook:
phonebook <phone number>
Looks <phone number> up on Google.
.. _command-google-translate:
translate <source language> [to] <target language> <text>

View File

@ -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 <reply> 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 <action> 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 <reply> (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 <reply> 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

View File

@ -61,6 +61,11 @@ add [<channel>] <question> <answer1> [<answer2> [<answer3> [...]]]
close [<channel>] <poll_id>
Closes the specified poll.
.. _command-poll-list:
list [<channel>]
Lists open polls in the <channel>.
.. _command-poll-results:
results [<channel>] <poll_id>

View File

@ -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:

View File

@ -50,8 +50,8 @@ md5 <text>
.. _command-string-ord:
ord <letter>
Returns the unicode codepoint of <letter>.
ord <string>
Returns the unicode codepoint of characters in <string>.
.. _command-string-re:
@ -70,8 +70,8 @@ soundex <string> [<length>]
.. _command-string-unicodename:
unicodename <character>
Returns the name of the given unicode <character>.
unicodename <string>
Returns the name of characters in <string>. This will error if any character is not a valid Unicode character.
.. _command-string-unicodesearch: