Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2025-01-27 20:54:31 +01:00
Code Issues Projects Releases Wiki Activity

Remove plugins docs.

Browse Source
This commit is contained in:
Valentin Lorentz 2013-01-31 19:33:47 +01:00
parent 640c5b70dc
commit 0cf36f7f8d
82 changed files with 1 additions and 8470 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
develop/index.rst
View File

@ -22,4 +22,5 @@ Other docs:
.. toctree::
:maxdepth: 0
callbacks.rst
httpserver.rst

109
use/plugins/admin.rst
View File

@ -1,109 +0,0 @@
.. _plugin-admin:
The Admin plugin
================
Capabilities
------------
.. _command-admin-capability-add:
capability add <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the user specified by *<name>* (or the user to whom *<hostmask>*
currently maps) the specified capability *<capability>*
.. _command-admin-capability-remove:
capability remove <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Takes from the user specified by *<name>* (or the user to whom
*<hostmask>* currently maps) the specified capability *<capability>*
Channels
--------
.. _command-admin-channels:
channels
^^^^^^^^
Returns the channels the bot is on. Must be given in private, in order
to protect the secrecy of secret channels.
.. _command-admin-join:
join <channel> [<key>]
^^^^^^^^^^^^^^^^^^^^^^
Tell the bot to join the given channel. If *<key>* is given, it is used
when attempting to join the channel.
.. _command-admin-part:
part [<channel>] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Tells the bot to part the list of channels you give it. *<channel>* is
only necessary if you want the bot to part a channel other than the
current channel. If *<reason>* is specified, use it as the part
message.
Ignores
-------
.. _command-admin-ignore-list:
ignore list
^^^^^^^^^^^
Lists the hostmasks that the bot is ignoring.
.. _command-admin-ignore-remove:
ignore remove <hostmask|nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This will remove the persistent ignore on *<hostmask>* or the
hostmask currently associated with *<nick>*.
.. _command-admin-ignore-add:
ignore add <hostmask|nick> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This will set a persistent ignore on *<hostmask>* or the hostmask
currently associated with *<nick>*. *<expires>* is an optional argument
specifying when (in "seconds from now") the ignore will expire; if
it isn't given, the ignore will never automatically expire.
Miscellaneous
-------------
.. _command-admin-nick:
nick [<nick>]
^^^^^^^^^^^^^
Changes the bot's nick to *<nick>*. If no nick is given, returns the
bot's current nick.
.. _plugin-admin-config:
Configuration
-------------
.. _supybot.plugins.Admin.public:
supybot.plugins.Admin.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

70
use/plugins/alias.rst
View File

@ -1,70 +0,0 @@
.. _plugin-alias:
The Alias plugin
================
Protecting
----------
.. _command-alias-lock:
lock <alias>
^^^^^^^^^^^^
Locks an alias so that no one else can change it.
.. _command-alias-unlock:
unlock <alias>
^^^^^^^^^^^^^^
Unlocks an alias so that people can define new aliases over it.
Adding and removing
-------------------
.. _command-alias-add:
add <name> <alias>
^^^^^^^^^^^^^^^^^^
Defines an alias *<name>* that executes *<alias>*. The *<alias>*
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-remove:
remove <name>
^^^^^^^^^^^^^
Removes the given alias, if unlocked.
.. _plugin-alias-config:
Configuration
-------------
.. _supybot.plugins.Alias.aliases:
supybot.plugins.Alias.aliases
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Alias.public:
supybot.plugins.Alias.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

76
use/plugins/anonymous.rst
View File

@ -1,76 +0,0 @@
.. _plugin-anonymous:
The Anonymous plugin
====================
Commands
--------
.. _command-channel-do:
do <channel> <action>
^^^^^^^^^^^^^^^^^^^^^
Performs *<action>* in *<channel>*.
.. _command-channel-say:
say <channel|nick> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^
Sends *<text>* to *<channel|nick>*. Can only send to *<nick>* if
:ref:`supybot.plugins.Anonymous.allowPrivateTarget` is True.
.. _plugin-anonymous-config:
Configuration
-------------
.. _supybot.plugins.Anonymous.requirePresenceInChannel:
supybot.plugins.Anonymous.requirePresenceInChannel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot should require people trying to use this plugin to be in the channel they wish to anonymously send to.
.. _supybot.plugins.Anonymous.allowPrivateTarget:
supybot.plugins.Anonymous.allowPrivateTarget
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will require targets of the "say" command to be public (i.e., channels). If this is True, the bot will allow people to use the "say" command to send private messages to other users.
.. _supybot.plugins.Anonymous.public:
supybot.plugins.Anonymous.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.Anonymous.requireCapability:
supybot.plugins.Anonymous.requireCapability
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what capability (if any) the bot should require people trying to use this plugin to have.
.. _supybot.plugins.Anonymous.requireRegistration:
supybot.plugins.Anonymous.requireRegistration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot should require people trying to use this plugin to be registered.

258
use/plugins/attackprotector.rst
View File

@ -1,258 +0,0 @@
.. _plugin-attackprotector:
The AttackProtector plugin
==========================
.. include:: unofficial.inc
.. _plugin-attackprotector-config:
Configuration
-------------
.. _supybot.plugins.AttackProtector.groupjoin:
supybot.plugins.AttackProtector.groupjoin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.AttackProtector.groupjoin.detection:
supybot.plugins.AttackProtector.groupjoin.detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 20p10
In the format XpY, where X is the number of groupjoin per Y seconds that triggers the punishment.
.. _supybot.plugins.AttackProtector.groupjoin.punishment:
supybot.plugins.AttackProtector.groupjoin.punishment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: mode+i
Determines the pushiment applyed when a groupjoin flood is detected.
.. _supybot.plugins.AttackProtector.groupmessage:
supybot.plugins.AttackProtector.groupmessage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.AttackProtector.groupmessage.detection:
supybot.plugins.AttackProtector.groupmessage.detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 100p10
In the format XpY, where X is the number of groupmessage per Y seconds that triggers the punishment.
.. _supybot.plugins.AttackProtector.groupmessage.punishment:
supybot.plugins.AttackProtector.groupmessage.punishment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: mode+m
Determines the pushiment applyed when a groupmessage flood is detected.
.. _supybot.plugins.AttackProtector.groupnick:
supybot.plugins.AttackProtector.groupnick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.AttackProtector.groupnick.detection:
supybot.plugins.AttackProtector.groupnick.detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 20p10
In the format XpY, where X is the number of groupnick per Y seconds that triggers the punishment.
.. _supybot.plugins.AttackProtector.groupnick.punishment:
supybot.plugins.AttackProtector.groupnick.punishment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: mode+N
Determines the pushiment applyed when a groupnick flood is detected.
.. _supybot.plugins.AttackProtector.grouppart:
supybot.plugins.AttackProtector.grouppart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.AttackProtector.grouppart.detection:
supybot.plugins.AttackProtector.grouppart.detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 20p10
In the format XpY, where X is the number of grouppart per Y seconds that triggers the punishment.
.. _supybot.plugins.AttackProtector.grouppart.punishment:
supybot.plugins.AttackProtector.grouppart.punishment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: mode+i
Determines the pushiment applyed when a grouppart flood is detected.
.. _supybot.plugins.AttackProtector.join:
supybot.plugins.AttackProtector.join
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.AttackProtector.join.detection:
supybot.plugins.AttackProtector.join.detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 5p10
In the format XpY, where X is the number of join per Y seconds that triggers the punishment.
.. _supybot.plugins.AttackProtector.join.punishment:
supybot.plugins.AttackProtector.join.punishment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: ban
Determines the pushiment applyed when a join flood is detected.
.. _supybot.plugins.AttackProtector.message:
supybot.plugins.AttackProtector.message
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.AttackProtector.message.detection:
supybot.plugins.AttackProtector.message.detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 10p20
In the format XpY, where X is the number of message per Y seconds that triggers the punishment.
.. _supybot.plugins.AttackProtector.message.punishment:
supybot.plugins.AttackProtector.message.punishment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: kick
Determines the pushiment applyed when a message flood is detected.
.. _supybot.plugins.AttackProtector.nick:
supybot.plugins.AttackProtector.nick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.AttackProtector.nick.detection:
supybot.plugins.AttackProtector.nick.detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 7p300
In the format XpY, where X is the number of nick per Y seconds that triggers the punishment.
.. _supybot.plugins.AttackProtector.nick.punishment:
supybot.plugins.AttackProtector.nick.punishment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: ban
Determines the pushiment applyed when a nick flood is detected.
.. _supybot.plugins.AttackProtector.part:
supybot.plugins.AttackProtector.part
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.AttackProtector.part.detection:
supybot.plugins.AttackProtector.part.detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 4p5
In the format XpY, where X is the number of part per Y seconds that triggers the punishment.
.. _supybot.plugins.AttackProtector.part.punishment:
supybot.plugins.AttackProtector.part.punishment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: ban
Determines the pushiment applyed when a part flood is detected.
.. _supybot.plugins.AttackProtector.delay:
supybot.plugins.AttackProtector.delay
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 10
Determines how long (in seconds) the plugin will wait before being enabled. A too low value makes the bot believe that its incoming messages 'flood' on connection is an attack.
.. _supybot.plugins.AttackProtector.exempt:
supybot.plugins.AttackProtector.exempt
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: nopunish
If a user has this capability, he won't be punished by AttackProtector
.. _supybot.plugins.AttackProtector.public:
supybot.plugins.AttackProtector.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

105
use/plugins/automode.rst
View File

@ -1,105 +0,0 @@
.. _plugin-automode:
The AutoMode plugin
===================
This plugins enables your bot to automatically voice, halfop, and op people on
your channel, according to their capabilities.
Owners
------
Owners are always opped unless you set :ref:`supybot.plugins.AutoMode.owner`
to False.
With stock Supybot and Gribble, setting this to False will cause no automode
at all for owners. In Limnoria, settings this to False will make automode
work as for normal users (only channel capabilities count).
.. _plugin-automode-config:
Configuration
-------------
.. _supybot.plugins.AutoMode.enable:
supybot.plugins.AutoMode.enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is enabled.
.. _supybot.plugins.AutoMode.fallthrough:
supybot.plugins.AutoMode.fallthrough
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will "fall through" to halfop/voicing when auto-opping is turned off but auto-halfopping/voicing are turned on.
.. _supybot.plugins.AutoMode.halfop:
supybot.plugins.AutoMode.halfop
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will automatically halfop people with the <channel>,halfop capability when they join the channel.
.. _supybot.plugins.AutoMode.op:
supybot.plugins.AutoMode.op
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will automatically op people with the <channel>,op capability when they join the channel.
.. _supybot.plugins.AutoMode.voice:
supybot.plugins.AutoMode.voice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will automatically voice people with the <channel>,voice capability when they join the channel.
.. _supybot.plugins.AutoMode.ban:
supybot.plugins.AutoMode.ban
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will automatically ban people who join the channel and are on the banlist.
.. _supybot.plugins.AutoMode.ban.period:
supybot.plugins.AutoMode.ban.period
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 86400
Determines how many seconds the bot will automatically ban a person when banning.
.. _supybot.plugins.AutoMode.owner:
supybot.plugins.AutoMode.owner
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin will automode owners even if they don't have op/halfop/voice/whatever capability.
.. _supybot.plugins.AutoMode.public:
supybot.plugins.AutoMode.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

118
use/plugins/badwords.rst
View File

@ -1,118 +0,0 @@
.. _plugin-badwords:
The BadWords plugin
===================
Commands
--------
.. _command-channel-list:
list
^^^^
Returns the list of words being censored.
.. _command-channel-remove:
remove <word> [<word> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes *<word>s* from the list of words being censored.
.. _command-channel-add:
add <word> [<word> ...]
^^^^^^^^^^^^^^^^^^^^^^^
Adds all *<word>s* to the list of words being censored.
.. _plugin-badwords-config:
Configuration
-------------
.. _supybot.plugins.BadWords.kick:
supybot.plugins.BadWords.kick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will kick people with a warning when they use bad words.
.. _supybot.plugins.BadWords.kick.message:
supybot.plugins.BadWords.kick.message
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: You have been kicked for using a word prohibited in the presence of this bot. Please use more appropriate language in the future.
Determines the kick message used by the bot when kicking users for saying bad words.
.. _supybot.plugins.BadWords.nastyChars:
supybot.plugins.BadWords.nastyChars
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: !@#&
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.
.. _supybot.plugins.BadWords.public:
supybot.plugins.BadWords.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.BadWords.replaceMethod:
supybot.plugins.BadWords.replaceMethod
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: nastyCharacters
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.
.. _supybot.plugins.BadWords.requireWordBoundaries:
supybot.plugins.BadWords.requireWordBoundaries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
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.
.. _supybot.plugins.BadWords.simpleReplacement:
supybot.plugins.BadWords.simpleReplacement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: [CENSORED]
Determines what word will replace bad words if the replacement method is 'simple'.
.. _supybot.plugins.BadWords.stripFormatting:
supybot.plugins.BadWords.stripFormatting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
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.
.. _supybot.plugins.BadWords.words:
supybot.plugins.BadWords.words
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
Determines what words are considered to be 'bad' so the bot won't say them.

47
use/plugins/brainfuck.rst
View File

@ -1,47 +0,0 @@
.. _plugin-brainfuck:
The Brainfuck plugin
====================
.. include:: unofficial.inc
Commands
--------
.. _command-brainfuck-brainfuck:
brainfuck brainfuck [--recover] [--input <characters>] <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Interprets the given Brainfuck code. You should quote the code if you
use brackets, because Supybot would interpret it as nested commands.
If *--recover* is given, the bot will recover the previous processor
memory and memory pointer.
The code will be fed the *<characters>* when it asks for input.
.. _command-brainfuck-checksyntax:
brainfuck checksyntax <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Tests the Brainfuck syntax without running it. You should quote the
code if you use brackets, because Supybot would interpret it as nested
commands.
.. _plugin-brainfuck-config:
Configuration
-------------
.. _supybot.plugins.Brainfuck.public:
supybot.plugins.Brainfuck.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

390
use/plugins/channel.rst
View File

@ -1,390 +0,0 @@
.. _plugin-channel:
The Channel plugin
==================
Lobotomy
--------
.. _command-channel-lobotomy-list:
lobotomy list
^^^^^^^^^^^^^
Returns the channels in which this bot is lobotomized.
.. _command-channel-lobotomy-remove:
lobotomy remove [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will unlobotomize the
bot, making it respond to requests made in the channel again.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-channel-lobotomy-add:
lobotomy add [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will "lobotomize" the
bot, making it silent and unanswering to all requests made in the
channel. *<channel>* is only necessary if the message isn't sent in
the channel itself.
(Un)setting modes
-----------------
.. _command-channel-unmoderate:
unmoderate [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Sets -m on *<channel>*, making it so everyone can
send messages to the channel. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-channel-devoice:
devoice [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove voice from all
the nicks given. If no nicks are given, removes voice from the person
sending the message.
.. _command-channel-deop:
deop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove operator
privileges from all the nicks given. If no nicks are given, removes
operator privileges from the person sending the message.
.. _command-channel-limit:
limit [<channel>] [<limit>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the channel limit to *<limit>*. If *<limit>* is 0, or isn't given,
removes the channel limit. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-channel-moderate:
moderate [<channel>]
^^^^^^^^^^^^^^^^^^^^
Sets +m on *<channel>*, making it so only ops and voiced users can
send messages to the channel. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-channel-unban:
unban [<channel>] [<hostmask>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unbans *<hostmask>* on *<channel>*. If *<hostmask>* is not given, unbans
any hostmask currently banned on *<channel>* that matches your current
hostmask. Especially useful for unbanning yourself when you get
unexpectedly (or accidentally) banned from the channel. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-channel-dehalfop:
dehalfop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove half-operator
privileges from all the nicks given. If no nicks are given, removes
half-operator privileges from the person sending the message.
.. _command-channel-key:
key [<channel>] [<key>]
^^^^^^^^^^^^^^^^^^^^^^^
Sets the keyword in *<channel>* to *<key>*. If *<key>* is not given, removes
the keyword requirement to join *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-channel-halfop:
halfop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,halfop capability, this will give all the
*<nick>*s you provide halfops. If you don't provide any *<nick>*s, this
will give you halfops. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-channel-mode:
mode [<channel>] <mode> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the mode in *<channel>* to *<mode>*, sending the arguments given.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-channel-ban-list:
ban list [<channel>]
^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will show you the
current persistent bans on #channel.
.. _command-channel-ban-remove:
ban remove [<channel>] <hostmask>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove the
persistent ban on *<hostmask>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-channel-ban-add:
ban add [<channel>] <nick|hostmask> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will effect a
persistent ban from interacting with the bot on the given
*<hostmask>* (or the current hostmask associated with *<nick>*. Other
plugins may enforce this ban by actually banning users with
matching hostmasks when they join. *<expires>* is an optional
argument specifying when (in "seconds from now") the ban should
expire; if none is given, the ban will never automatically expire.
*<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-channel-voice:
voice [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,voice capability, this will voice all the
*<nick>*s you provide. If you don't provide any *<nick>*s, this will
voice you. *<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-channel-op:
op [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will give all the *<nick>*s
you provide ops. If you don't provide any *<nick>*s, this will op you.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
Inviting and kicking users
--------------------------
.. _command-channel-kick:
kick [<channel>] <nick>[, <nick>, ...] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Kicks *<nick>*(s) from *<channel>* for *<reason>*. If *<reason>* isn't given,
uses the nick of the person making the command as the reason.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-channel-invite:
invite [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will invite *<nick>*
to join *<channel>*. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-channel-kban:
kban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will kickban *<nick>* for
as many seconds as you specify, or else (if you specify 0 seconds or
don't specify a number of seconds) it will ban the person indefinitely.
*--exact* bans only the exact hostmask; *--nick* bans just the nick;
*--user* bans just the user, and *--host* bans just the host. You can
combine these options as you choose. *<reason>* is a reason to give for
the kick.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-channel-cycle:
cycle [<channel>]
^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will cause the bot to
"cycle", or PART and then JOIN the channel. *<channel>* is only necessary
if the message isn't sent in the channel itself.
Utitilies
---------
.. _command-channel-nicks:
nicks [<channel>] [--count]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the nicks in *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself. Returns only the number of
nicks if *--count* option is provided.
.. _command-channel-alert:
alert [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Sends *<text>* to all the users in *<channel>* who have the *<channel>*,op
capability.
.. _command-channel-disable:
disable [<channel>] [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will disable the *<command>*
in *<channel>*. If *<plugin>* is provided, *<command>* will be disabled only
for that plugin. If only *<plugin>* is provided, all commands in the
given plugin will be disabled. *<channel>* is only necessary if the
message isn't sent in the channel itself.
Ignores
-------
.. _command-channel-ignore-list:
ignore list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Lists the hostmasks that the bot is ignoring on the given channel.
*<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-channel-ignore-remove:
ignore remove [<channel>] <hostmask>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove the
persistent ignore on *<hostmask>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-channel-ignore-add:
ignore add [<channel>] <nick|hostmask> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will set a persistent
ignore on *<hostmask>* or the hostmask currently
associated with *<nick>*. *<expires>* is an optional argument
specifying when (in "seconds from now") the ignore will expire; if
it isn't given, the ignore will never automatically expire.
*<channel>* is only necessary if the message isn't sent in the
channel itself.
Capabilities
------------
.. _command-channel-capability-set:
capability set [<channel>] <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will add the channel
capability *<capability>* for all users in the channel. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-channel-capability-setdefault:
capability setdefault [<channel>] {True|False}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will set the default
response to non-power-related (that is, not {op, halfop, voice}
capabilities to be the value you give. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-channel-capability-list:
capability list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the capabilities present on the *<channel>*. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-channel-capability-remove:
capability remove [<channel>] <name|hostmask> <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will take from the
user currently identified as *<name>* (or the user to whom *<hostmask>*
maps) the capability *<capability>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-channel-capability-add:
capability add [<channel>] <nick|username> <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will give the user
*<name>* (or the user to whom *<nick>* maps)
the capability *<capability>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-channel-capability-unset:
capability unset [<channel>] <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will unset the channel
capability *<capability>* so each user's specific capability or the
channel default capability will take precedence. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-channel-enable:
enable [<channel>] [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will enable the *<command>*
in *<channel>* if it has been disabled. If *<plugin>* is provided,
*<command>* will be enabled only for that plugin. If only *<plugin>* is
provided, all commands in the given plugin will be enabled. *<channel>*
is only necessary if the message isn't sent in the channel itself.
.. _plugin-channel-config:
Configuration
-------------
.. _supybot.plugins.Channel.alwaysRejoin:
supybot.plugins.Channel.alwaysRejoin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will always try to rejoin a channel whenever it's kicked from the channel.
.. _supybot.plugins.Channel.public:
supybot.plugins.Channel.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

130
use/plugins/channellogger.rst
View File

@ -1,130 +0,0 @@
.. _plugin-channellogger:
The ChannelLogger plugin
========================
.. _plugin-channellogger-config:
Configuration
-------------
.. _supybot.plugins.ChannelLogger.enable:
supybot.plugins.ChannelLogger.enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether logging is enabled.
.. _supybot.plugins.ChannelLogger.filenameTimestamp:
supybot.plugins.ChannelLogger.filenameTimestamp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: %Y-%m-%d
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.
.. _supybot.plugins.ChannelLogger.noLogPrefix:
supybot.plugins.ChannelLogger.noLogPrefix
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: [nolog]
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.
.. _supybot.plugins.ChannelLogger.rotateLogs:
supybot.plugins.ChannelLogger.rotateLogs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
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.
.. _supybot.plugins.ChannelLogger.stripFormatting:
supybot.plugins.ChannelLogger.stripFormatting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether formatting characters (such as bolding, color, etc.) are removed when writing the logs to disk.
.. _supybot.plugins.ChannelLogger.timestamp:
supybot.plugins.ChannelLogger.timestamp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the logs for this channel are timestamped with the timestamp in supybot.log.timestampFormat.
.. _supybot.plugins.ChannelLogger.directories:
supybot.plugins.ChannelLogger.directories
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will partition its channel logs into separate directories based on different criteria.
.. _supybot.plugins.ChannelLogger.directories.timestamp:
supybot.plugins.ChannelLogger.directories.timestamp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will use a timestamp (determined by supybot.plugins.ChannelLogger.directories.timestamp.format) if using directories.
.. _supybot.plugins.ChannelLogger.directories.timestamp.format:
supybot.plugins.ChannelLogger.directories.timestamp.format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: %B
Determines what timestamp format will be used in the directory structure for channel logs if supybot.plugins.ChannelLogger.directories.timestamp is True.
.. _supybot.plugins.ChannelLogger.directories.channel:
supybot.plugins.ChannelLogger.directories.channel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will use a channel directory if using directories.
.. _supybot.plugins.ChannelLogger.directories.network:
supybot.plugins.ChannelLogger.directories.network
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will use a network directory if using directories.
.. _supybot.plugins.ChannelLogger.flushImmediately:
supybot.plugins.ChannelLogger.flushImmediately
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether channel logfiles will be flushed anytime they're written to, rather than being buffered by the operating system.
.. _supybot.plugins.ChannelLogger.public:
supybot.plugins.ChannelLogger.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

80
use/plugins/channelstats.rst
View File

@ -1,80 +0,0 @@
.. _plugin-channelstats:
The ChannelStats plugin
=======================
Commands
--------
.. _command-channelstats-stats:
channelstats stats [<channel>] [<name>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the statistics for *<name>* on *<channel>*. *<channel>* is only
necessary if the message isn't sent on the channel itself. If *<name>*
isn't given, it defaults to the user sending the command.
.. _command-channelstats-rank:
channelstats rank [<channel>] <stat expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the ranking of users according to the given stat expression.
Valid variables in the stat expression include 'msgs', 'chars',
'words', 'smileys', 'frowns', 'actions', 'joins', 'parts', 'quits',
'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical
expression involving those variables is permitted.
.. _command-channelstats-channelstats:
channelstats channelstats [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the statistics for *<channel>*. *<channel>* is only necessary if
the message isn't sent on the channel itself.
.. _plugin-channelstats-config:
Configuration
-------------
.. _supybot.plugins.ChannelStats.frowns:
supybot.plugins.ChannelStats.frowns
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: [':\|', ':-/', ':-\\', ':\\', ':/', ':(', ':-(', ":'("]
Determines what words (i.e., pieces of text with no spaces in them ) are considered 'frowns' for the purposes of stats-keeping.
.. _supybot.plugins.ChannelStats.selfStats:
supybot.plugins.ChannelStats.selfStats
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
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).
.. _supybot.plugins.ChannelStats.smileys:
supybot.plugins.ChannelStats.smileys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: [':)', ';)', ';]', ':-)', ':-D', ':D', ':P', ':p', '(=', '=)']
Determines what words (i.e., pieces of text with no spaces in them) are considered 'smileys' for the purposes of stats-keeping.
.. _supybot.plugins.ChannelStats.public:
supybot.plugins.ChannelStats.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

34
use/plugins/coffee.rst
View File

@ -1,34 +0,0 @@
.. _plugin-coffee:
The Coffee plugin
=================
.. include:: unofficial.inc
.. _command-coffee-coffee:
coffee coffee
^^^^^^^^^^^^^
Makes coffee using the Hyper Text Coffee Pot Control Protocol
(HTCPCP/1.0). More info at http://www.ietf.org/rfc/rfc2324.txt
Warning: this command has side effect if no compatible device
is found on the channel.
.. _plugin-coffee-config:
Configuration
-------------
.. _supybot.plugins.Coffee.public:
supybot.plugins.Coffee.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

167
use/plugins/conditional.rst
View File

@ -1,167 +0,0 @@
.. _plugin-conditional:
The Conditional plugin
======================
Numeric comparison
------------------
.. _command-conditional-nlt:
conditional nlt <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a numeric comparison on *<item1>* and *<item2>*.
Returns true if *<item1>* is less than *<item2>*.
.. _command-conditional-nne:
conditional nne <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a numeric comparison on *<item1>* and *<item2>*.
Returns true if they are not equal.
.. _command-conditional-nle:
conditional nle <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a numeric comparison on *<item1>* and *<item2>*.
Returns true if *<item1>* is less than or equal to *<item2>*.
.. _command-conditional-nge:
conditional nge <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a numeric comparison on *<item1>* and *<item2>*.
Returns true if *<item1>* is greater than or equal to *<item2>*.
.. _command-conditional-nceq:
conditional nceq <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a numeric comparison on *<item1>* and *<item2>*.
Returns true if they are equal.
.. _command-conditional-ngt:
conditional ngt <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a numeric comparison on *<item1>* and *<item2>*.
Returns true if they *<item1>* is greater than *<item2>*.
String comparison
-----------------
.. _command-conditional-le:
conditional le <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a string comparison on *<item1>* and *<item2>*.
Returns true if *<item1>* is less than or equal to *<item2>*.
.. _command-conditional-ceq:
conditional ceq <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a string comparison on *<item1>* and *<item2>*.
Returns true if they are equal.
.. _command-conditional-gt:
conditional gt <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a string comparison on *<item1>* and *<item2>*.
Returns true if *<item1>* is greater than *<item2>*.
.. _command-conditional-ge:
conditional ge <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a string comparison on *<item1>* and *<item2>*.
Returns true if *<item1>* is greater than or equal to *<item2>*.
.. _command-conditional-ne:
conditional ne <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a string comparison on *<item1>* and *<item2>*.
Returns true if they are not equal.
.. _command-conditional-lt:
conditional lt <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a string comparison on *<item1>* and *<item2>*.
Returns true if *<item1>* is less than *<item2>*.
.. _command-conditional-match:
conditional match <item1> <item2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Determines if *<item1>* is a substring of *<item2>*.
Returns true if *<item1>* is contained in *<item2>*.
Logical operators
-----------------
.. _command-conditional-cand:
conditional cand <cond1> [<cond2> ... <condN>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns true if all conditions supplied evaluate to true.
.. _command-conditional-cxor:
conditional cxor <cond1> [<cond2> ... <condN>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns true if only one of conditions supplied evaluates to true.
.. _command-conditional-cor:
conditional cor <cond1> [<cond2> ... <condN>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns true if any one of conditions supplied evaluates to true.
.. _command-conditional-cif:
conditional cif <condition> <ifcommand> <elsecommand>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Runs *<ifcommand>* if *<condition>* evaluates to true, runs *<elsecommand>*
if it evaluates to false.
Use other logical operators defined in this plugin and command nesting
to your advantage here.
.. _plugin-conditional-config:
Configuration
-------------
.. _supybot.plugins.Conditional.public:
supybot.plugins.Conditional.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

98
use/plugins/config.rst
View File

@ -1,98 +0,0 @@
.. _plugin-config:
The Config plugin
=================
Accessing config
----------------
.. _command-config-help:
config help <name>
^^^^^^^^^^^^^^^^^^
Returns the description of the configuration variable *<name>*.
.. _command-config-default:
config default <name>
^^^^^^^^^^^^^^^^^^^^^
Returns the default value of the configuration variable *<name>*.
.. _command-config-list:
config 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.
.. _command-config-search:
config search <word>
^^^^^^^^^^^^^^^^^^^^
Searches for *<word>* in the current configuration variables.
.. _command-config-channel:
config channel [<channel>] <name> [<value>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If *<value>* is given, sets the channel configuration variable for *<name>*
to *<value>* for *<channel>*. Otherwise, returns the current channel
configuration value of *<name>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-config-config:
config config <name> [<value>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If *<value>* is given, sets the value of *<name>* to *<value>*. Otherwise,
returns the current value of *<name>*. You may omit the leading
"supybot." in the name if you so choose.
Maintenance
-----------
.. _command-config-reload:
config reload
^^^^^^^^^^^^^
Reloads the various configuration files (user database, channel
database, registry, etc.).
.. _command-config-export:
config export <filename>
^^^^^^^^^^^^^^^^^^^^^^^^
Exports the public variables of your configuration to *<filename>*.
If you want to show someone your configuration file, but you don't
want that person to be able to see things like passwords, etc., this
command will export a "sanitized" configuration file suitable for
showing publicly.
.. _plugin-config-config:
Configuration
-------------
.. _supybot.plugins.Config.public:
supybot.plugins.Config.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

45
use/plugins/ctcp.rst
View File

@ -1,45 +0,0 @@
.. _plugin-ctcp:
The Ctcp plugin
===============
Command
-------
.. _command-ctcp-version:
ctcp version [<channel>] [--nicks]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sends a CTCP VERSION to *<channel>*, returning the various
version strings returned. It waits for 10 seconds before returning
the versions received at that point. If *--nicks* is given, nicks are
associated with the version strings; otherwise, only the version
strings are given.
.. _plugin-ctcp-config:
Configuration
-------------
.. _supybot.plugins.Ctcp.public:
supybot.plugins.Ctcp.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.Ctcp.versionWait:
supybot.plugins.Ctcp.versionWait
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 10
Determines how many seconds the bot will wait after getting a version command (not a CTCP VERSION, but an actual call of the command in this plugin named "version") before replying with the results it has collected.

91
use/plugins/debian.rst
View File

@ -1,91 +0,0 @@
.. _plugin-debian:
The Debian plugin
=================
.. include:: unofficial.inc
Commands
--------
.. _command-debian-file:
debian file [--exact] [--mode {path,filename,exactfilename}] [--branch {oldstable,stable,testing,unstable,experimental}] [--section {main,contrib,non-free}] <file name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the package(s) containing the *<file name>*.
*--mode* defaults to path, and defines how to search.
*--branch* defaults to stable, and defines in what branch to search.
.. _command-debian-bug:
debian bug <num>
^^^^^^^^^^^^^^^^
Returns a description of the bug with bug id *<num>*.
.. _command-debian-stats:
debian stats <source package>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Reports various statistics (from http://packages.qa.debian.org/) about
*<source package>*.
.. _command-debian-incoming:
debian incoming [--{regexp,arch} <value>] [<glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Checks debian incoming for a matching package name. The arch
parameter defaults to i386; *--regexp* returns only those package names
that match a given regexp, and normal matches use standard \*nix
globbing.
.. _command-debian-version:
debian version [--exact] [--searchon {names,all,sourcenames}] [--branch {oldstable,stable,testing,unstable,experimental}] [--section {main,contrib,non-free}] <package name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current version(s) of the Debian package *<package name>*.
*--exact,* if given, means you want only the *<package name>*, and not
package names containing this name.
*--searchon* defaults to names, and defines where to search.
*--branch* defaults to all, and defines in what branch to search.
*--section* defaults to all, and defines in what section to search.
.. _command-debian-new:
debian new [{main,contrib,non-free}] [<version>] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Checks for packages that have been added to Debian's unstable branch
in the past week. If no glob is specified, returns a list of all
packages. If no section is specified, defaults to main.
.. _plugin-debian-config:
Configuration
-------------
.. _supybot.plugins.Debian.bold:
supybot.plugins.Debian.bold
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the plugin will use bold in the responses to some of its commands.
.. _supybot.plugins.Debian.public:
supybot.plugins.Debian.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

76
use/plugins/dict.rst
View File

@ -1,76 +0,0 @@
.. _plugin-dict:
The Dict plugin
===============
Commands
--------
.. _command-dict-synonym:
dict synonym <word> [<word> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gets a random synonym from the Moby Thesaurus (moby-thes) database.
If given many words, gets a random synonym for each of them.
Quote phrases to have them treated as one lookup word.
.. _command-dict-dict:
dict dict [<dictionary>] <word>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the definition of *<word>* on the dictd server specified by
the :ref:`supybot.plugins.Dict.server` config variable.
.. _command-dict-random:
dict random
^^^^^^^^^^^
Returns a random valid dictionary.
.. _command-dict-dictionaries:
dict dictionaries
^^^^^^^^^^^^^^^^^
Returns the dictionaries valid for the dict command.
.. _plugin-dict-config:
Configuration
-------------
.. _supybot.plugins.Dict.default:
supybot.plugins.Dict.default
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
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.
.. _supybot.plugins.Dict.public:
supybot.plugins.Dict.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.Dict.server:
supybot.plugins.Dict.server
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: dict.org
Determines what server the bot will retrieve definitions from.

31
use/plugins/dunno.rst
View File

@ -1,31 +0,0 @@
.. _plugin-dunno:
The Dunno plugin
================
.. _plugin-dunno-config:
Configuration
-------------
.. _supybot.plugins.Dunno.prefixNick:
supybot.plugins.Dunno.prefixNick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will prefix the nick of the user giving an invalid command to the "dunno" response.
.. _supybot.plugins.Dunno.public:
supybot.plugins.Dunno.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

104
use/plugins/erepublik.rst
View File

@ -1,104 +0,0 @@
.. _plugin-erepublik:
The ERepublik plugin
====================
.. include:: unofficial.inc
Commands
--------
.. _command-erepublik-info:
erepublik info <name|id>
^^^^^^^^^^^^^^^^^^^^^^^^
Displays informations on the given citizen.
.. _command-erepublik-money:
erepublik money <name>
^^^^^^^^^^^^^^^^^^^^^^
Displays money's rates.
.. _command-erepublik-fight:
erepublik fight <name|id>
^^^^^^^^^^^^^^^^^^^^^^^^^
Shows how many damages you can make in one hit.
.. _command-erepublik-see:
erepublik see <name|id>
^^^^^^^^^^^^^^^^^^^^^^^
Displays informations on the given citizen.
.. _command-erepublik-land:
erepublik land take no arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the eRepublik land links.
.. _command-erepublik-link:
erepublik link <user|id>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns the link to the user's profile.
.. _command-erepublik-medals:
erepublik medals <name|id>
^^^^^^^^^^^^^^^^^^^^^^^^^^
Displays the citizen's medals.
.. _command-erepublik-invasion:
erepublik invasion <channel>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Calls for invasion of the channel.
.. _command-erepublik-menu:
erepublik menu take no arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the eRepublik main links.
.. _command-erepublik-kamikaze:
erepublik kamikaze <name|id>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Shows how many damages you can make in one hit.
.. _command-erepublik-donate:
erepublik donate <user|id>
^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the link to the user's 'donate' page.
.. _plugin-erepublik-config:
Configuration
-------------
.. _supybot.plugins.ERepublik.public:
supybot.plugins.ERepublik.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

127
use/plugins/eureka.rst
View File

@ -1,127 +0,0 @@
.. _plugin-eureka:
The Eureka plugin
=================
.. include:: unofficial.inc
Start and stop
--------------
.. _command-eureka-start:
eureka start [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
Start the Eureka on the given *<channel>*. If *<channel>* is not given,
it defaults to the current channel.
.. _command-eureka-stop:
eureka stop [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Stop the Eureka on the given *<channel>*. If *<channel>* is not given,
it defaults to the current channel.
.. _command-eureka-pause:
eureka pause [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
Pause the Eureka on the given *<channel>*. If *<channel>* is not given,
it defaults to the current channel.
.. _command-eureka-resume:
eureka resume [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
Resume the Eureka on the given *<channel>*. If *<channel>* is not given,
it defaults to the current channel.
Moderation
----------
.. _command-eureka-adjust:
eureka adjust [<channel>] <nick> <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Increase or decrease the score of *<nick>* on the *<channel>*.
If *<channel>* is not given, it defaults to the current channel.
.. _command-eureka-skip:
eureka skip [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Give up with this question, and switch to the next one.
.. _command-eureka-clue:
eureka clue [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Give the next clue.
Scores
------
.. _command-eureka-scores:
eureka scores [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
Return the scores on the *<channel>*. If *<channel>* is not given, it
defaults to the current channel.
.. _command-eureka-score:
eureka score [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Return the score of *<nick>* on the *<channel>*. If *<channel>* is not
given, it defaults to the current channel.
.. _plugin-eureka-config:
Configuration
-------------
.. _supybot.plugins.Eureka.format:
supybot.plugins.Eureka.format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Eureka.format.score:
supybot.plugins.Eureka.format.score
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: $nick ($score)
Determines the format used by the bot to display the score of a user.
.. _supybot.plugins.Eureka.format.separator:
supybot.plugins.Eureka.format.separator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: //
Determines the string between two user scores.
.. _supybot.plugins.Eureka.public:
supybot.plugins.Eureka.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

212
use/plugins/factoids.rst
View File

@ -1,212 +0,0 @@
.. _plugin-factoids:
The Factoids plugin
===================
Reading factoids
----------------
.. _command-factoids-info:
factoids info [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives information about the factoid(s) associated with *<key>*.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-factoids-random:
factoids random [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a random factoid from the database for *<channel>*. *<channel>*
is only necessary if the message isn't sent in the channel itself.
.. _command-factoids-search:
factoids search [<channel>] [--values] [--{regexp} <value>] [<glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches the keyspace for keys matching *<glob>*. If *--regexp* is given,
it 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-whatis:
factoids whatis [<channel>] [--raw] <key> [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the value of *<key>* in the factoid database. If given a
number, will return only that exact factoid. If '*--raw'* option is
given, no variable substitution will take place on the factoid.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-factoids-rank:
factoids rank [<channel>] [--plain] [--alpha] [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a list of top-ranked factoid keys, sorted by usage count
(rank). If *<number>* is not provided, the default number of factoid keys
returned is set by the rankListLength registry value.
If *--plain* option is given, rank numbers and usage counts are not
included in output.
If *--alpha* option is given in addition to *--plain,* keys are sorted
alphabetically, instead of by rank.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
Administration
--------------
.. _command-factoids-learn:
factoids learn [<channel>] <key> WORD <value>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Associates *<key>* with *<value>*. *<channel>* is only
necessary if the message isn't sent on the channel
itself. The WORD (defined in :ref:`supybot.plugins.Factoids.learnSeparator`)
is necessary to separate the
key from the value. It can be changed to another word
via the :ref:`supybot.plugins.Factoids.learnSeparator` registry value.
.. _command-factoids-forget:
factoids forget [<channel>] <key> [<number>|*]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes a key-fact relationship for key *<key>* from the factoids
database. If there is more than one such relationship for this key,
a number is necessary to determine which one should be removed.
A * can be used to remove all relationships for *<key>*.
If as a result, the key (factoid) remains without any relationships to
a factoid (key), it shall be removed from the database.
*<channel>* is only necessary if
the message isn't sent in the channel itself.
.. _command-factoids-unlock:
factoids unlock [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the factoid(s) associated with *<key>* so that they can be
removed or added to. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-factoids-alias:
factoids alias [<channel>] <oldkey> <newkey> [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds a new key *<newkey>* for factoid associated with *<oldkey>*.
*<number>* is only necessary if there's more than one factoid associated
with *<oldkey>*.
The same action can be accomplished by using the 'learn' function with
a new key but an existing (verbatim) factoid content.
.. _command-factoids-change:
factoids change [<channel>] <key> <number> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes the factoid #*<number>* associated with *<key>* according to
*<regexp>*.
.. _command-factoids-lock:
factoids lock [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Locks the factoid(s) associated with *<key>* so that they cannot be
removed or added to. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _plugin-factoids-config:
Configuration
-------------
.. _supybot.plugins.Factoids.format:
supybot.plugins.Factoids.format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: $key could be $value.
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.
.. _supybot.plugins.Factoids.keepRankInfo:
supybot.plugins.Factoids.keepRankInfo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether we keep updating the usage count for each factoid, for popularity ranking.
.. _supybot.plugins.Factoids.learnSeparator:
supybot.plugins.Factoids.learnSeparator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: as
Determines what separator must be used in the learn command. Defaults to 'as' -- learn <key> as <value>. Users might feel more comfortable with 'is' or something else, so it's configurable.
.. _supybot.plugins.Factoids.rankListLength:
supybot.plugins.Factoids.rankListLength
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 20
Determines the number of factoid keys returned by the factrank command.
.. _supybot.plugins.Factoids.replyApproximateSearchKeys:
supybot.plugins.Factoids.replyApproximateSearchKeys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
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.
.. _supybot.plugins.Factoids.replyWhenInvalidCommand:
supybot.plugins.Factoids.replyWhenInvalidCommand
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
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.
.. _supybot.plugins.Factoids.showFactoidIfOnlyOneMatch:
supybot.plugins.Factoids.showFactoidIfOnlyOneMatch
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will reply with the single matching factoid if only one factoid matches when using the search command.
.. _supybot.plugins.Factoids.public:
supybot.plugins.Factoids.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

271
use/plugins/filter.rst
View File

@ -1,271 +0,0 @@
.. _plugin-filter:
The Filter plugin
=================
Administration
--------------
.. _command-filter-outfilter:
filter outfilter [<channel>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the outFilter of this plugin to be *<command>*. If no command is
given, unsets the outFilter. *<channel>* is only necessary if the
message isn't sent in the channel itself.
Encoding and decoding
---------------------
.. _command-filter-hexlify:
filter hexlify <text>
^^^^^^^^^^^^^^^^^^^^^
Returns a hexstring from the given string; a hexstring is a string
composed of the hexadecimal value of each character in the string
.. _command-filter-unhexlify:
filter unhexlify <hexstring>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the string corresponding to *<hexstring>*. Obviously,
*<hexstring>* must be a string of hexadecimal digits.
.. _command-filter-binary:
filter binary <text>
^^^^^^^^^^^^^^^^^^^^
Returns the binary representation of *<text>*.
.. _command-filter-unbinary:
filter unbinary <text>
^^^^^^^^^^^^^^^^^^^^^^
Returns the character representation of binary *<text>*.
Assumes ASCII, 8 digits per character.
.. _command-filter-morse:
filter morse <text>
^^^^^^^^^^^^^^^^^^^
Gives the Morse code equivalent of a given string.
.. _command-filter-unmorse:
filter unmorse <Morse code text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does the reverse of the morse command.
Colors
------
.. _command-filter-stripcolor:
filter stripcolor <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* stripped of all color codes.
.. _command-filter-colorize:
filter colorize <text>
^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* with each character randomly colorized.
.. _command-filter-rainbow:
filter rainbow <text>
^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* colorized like a rainbow.
Utils
-----
.. _command-filter-shrink:
filter shrink <text>
^^^^^^^^^^^^^^^^^^^^
Returns *<text>* with each word longer than
:ref:`supybot.plugins.Filter.shrink.minimum` being shrunken (i.e., like
"internationalization" becomes "i18n").
.. _command-filter-uniud:
filter uniud <text>
^^^^^^^^^^^^^^^^^^^
Returns *<text>* rotated 180 degrees. Only really works for ASCII
printable characters.
.. _command-filter-scramble:
filter scramble <text>
^^^^^^^^^^^^^^^^^^^^^^
Replies with a string where each word is scrambled; i.e., each internal
letter (that is, all letters but the first and last) are shuffled.
Fun
---
.. _command-filter-undup:
filter undup <text>
^^^^^^^^^^^^^^^^^^^
Returns *<text>*, with all consecutive duplicated letters removed.
.. _command-filter-hebrew:
filter hebrew <text>
^^^^^^^^^^^^^^^^^^^^
Removes all the vowels from *<text>*. (If you're curious why this is
named 'hebrew' it's because I (jemfinch) thought of it in Hebrew class,
and printed Hebrew often elides the vowels.)
.. _command-filter-leet:
filter leet <text>
^^^^^^^^^^^^^^^^^^
Returns the l33tspeak version of *<text>*
.. _command-filter-lithp:
filter lithp <text>
^^^^^^^^^^^^^^^^^^^
Returns the lisping version of *<text>*
.. _command-filter-spellit:
filter spellit <text>
^^^^^^^^^^^^^^^^^^^^^
Returns *<text>*, phonetically spelled out.
.. _command-filter-aol:
filter aol <text>
^^^^^^^^^^^^^^^^^
Returns *<text>* as if an AOLuser had said it.
.. _command-filter-squish:
filter squish <text>
^^^^^^^^^^^^^^^^^^^^
Removes all the spaces from *<text>*.
.. _command-filter-reverse:
filter reverse <text>
^^^^^^^^^^^^^^^^^^^^^
Reverses *<text>*.
.. _command-filter-azn:
filter azn <text>
^^^^^^^^^^^^^^^^^
Returns *<text>* with the l's made into r's and r's made into l's.
.. _command-filter-gnu:
filter gnu <text>
^^^^^^^^^^^^^^^^^
Returns *<text>* as GNU/RMS would say it.
.. _command-filter-jeffk:
filter jeffk <text>
^^^^^^^^^^^^^^^^^^^
Returns *<text>* as if JeffK had said it himself.
.. _plugin-filter-config:
Configuration
-------------
.. _supybot.plugins.Filter.shrink:
supybot.plugins.Filter.shrink
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Filter.shrink.minimum:
supybot.plugins.Filter.shrink.minimum
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 4
Determines the minimum number of a letters in a word before it will be shrunken by the shrink command/filter.
.. _supybot.plugins.Filter.spellit:
supybot.plugins.Filter.spellit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Filter.spellit.replaceLetters:
supybot.plugins.Filter.spellit.replaceLetters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether or not to replace letters in the output of spellit.
.. _supybot.plugins.Filter.spellit.replaceNumbers:
supybot.plugins.Filter.spellit.replaceNumbers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether or not to replace numbers in the output of spellit.
.. _supybot.plugins.Filter.spellit.replacePunctuation:
supybot.plugins.Filter.spellit.replacePunctuation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether or not to replace punctuation in the output of spellit.
.. _supybot.plugins.Filter.public:
supybot.plugins.Filter.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

154
use/plugins/format.rst
View File

@ -1,154 +0,0 @@
.. _plugin-format:
The Format plugin
=================
Capitals
--------
.. _command-format-upper:
format upper <text>
^^^^^^^^^^^^^^^^^^^
Returns *<text>* uppercased.
.. _command-format-capitalize:
format capitalize <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* capitalized.
.. _command-format-lower:
format lower <text>
^^^^^^^^^^^^^^^^^^^
Returns *<text>* lowercased.
.. _command-format-title:
format title <text>
^^^^^^^^^^^^^^^^^^^
Returns *<text>* titlecased.
Text modifications
------------------
.. _command-format-format:
format format <format string> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expands a Python-style format string using the remaining args. Just be
sure always to use %s, not %d or %f or whatever, because all the args
are strings.
.. _command-format-color:
format color <foreground> [<background>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* with foreground color *<foreground>* and background color
*<background>* (if given)
.. _command-format-repr:
format repr <text>
^^^^^^^^^^^^^^^^^^
Returns the text surrounded by double quotes.
.. _command-format-replace:
format replace <substring to translate> <substring to replace it with> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replaces all non-overlapping occurrences of *<substring to translate>*
with *<substring to replace it with>* in *<text>*.
.. _command-format-field:
format field <number> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the *<number>th* space-separated field of *<text>*. I.e., if text
is "foo bar baz" and *<number>* is 2, "bar" is returned.
.. _command-format-concat:
format concat <string 1> <string 2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Concatenates two strings. Do keep in mind that this is *not* the same
thing as join "", since if *<string 2>* contains spaces, they won't be
removed by concat.
.. _command-format-translate:
format translate <chars to translate> <chars to replace those with> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replaces *<chars to translate>* with *<chars to replace those with>* in
*<text>*. The first and second arguments must necessarily be the same
length.
.. _command-format-cut:
format cut <size> <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Cuts *<text>* down to *<size>* by chopping off the rightmost characters in
excess of *<size>*. If *<size>* is a negative number, it chops that many
characters off the end of *<text>*.
.. _command-format-join:
format join <separator> <string 1> [<string> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Joins all the arguments together with *<separator>*.
.. _command-format-reverse:
format reverse <text>
^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* in reverse-video.
Text properties
---------------
.. _command-format-bold:
format bold <text>
^^^^^^^^^^^^^^^^^^
Returns *<text>* bolded.
.. _command-format-underline:
format underline <text>
^^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* underlined.
.. _plugin-format-config:
Configuration
-------------
.. _supybot.plugins.Format.public:
supybot.plugins.Format.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

68
use/plugins/games.rst
View File

@ -1,68 +0,0 @@
.. _plugin-games:
The Games plugin
================
Random
------
.. _command-games-dice:
games dice <dice>d<sides>
^^^^^^^^^^^^^^^^^^^^^^^^^
Rolls a die with *<sides>* number of sides *<dice>* times.
For example, 2d6 will roll 2 six-sided dice; 10d10 will roll 10
ten-sided dice.
.. _command-games-roulette:
games roulette [spin]
^^^^^^^^^^^^^^^^^^^^^
Fires the revolver. If the bullet was in the chamber, you're dead.
Tell me to spin the chambers and I will.
.. _command-games-eightball:
games eightball [<question>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Ask a question and the answer shall be provided.
.. _command-games-coin:
games coin
^^^^^^^^^^
Flips a coin and returns the result.
Miscellaneous
-------------
.. _command-games-monologue:
games monologue [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the number of consecutive lines you've sent in *<channel>*
without being interrupted by someone else (i.e. how long your current
'monologue' is). *<channel>* is only necessary if the message isn't sent
in the channel itself.
.. _plugin-games-config:
Configuration
-------------
.. _supybot.plugins.Games.public:
supybot.plugins.Games.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

93
use/plugins/github.rst
View File

@ -1,93 +0,0 @@
.. _plugin-github:
The GitHub plugin
=================
.. include:: unofficial.inc
Main commands
-------------
.. _command-github-repo-info:
github repo info <owner> <repository> [--enable <feature> <feature> ...] [--disable <feature> <feature>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Displays informations about *<owner>*'s *<repository>*.
Enable or disable features (ie. displayed data) according to the
request).
.. _command-github-repo-search:
github repo search <searched string> [--page <id>] [--language <language>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches the string in the repository names database. You can
specify the page *<id>* of the results, and restrict the search
to a particular programming *<language>*.
Announces
---------
.. _command-github-announce-remove:
github announce remove [<channel>] <owner> <name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Don't announce the commits of the GitHub repository called
*<owner>*/*<name>* in the *<channel>* anymore.
*<channel>* defaults to the current channel.
.. _command-github-announce-add:
github announce add [<channel>] <owner> <name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announce the commits of the GitHub repository called
*<owner>*/*<name>* in the *<channel>*.
*<channel>* defaults to the current channel.
.. _plugin-github-config:
Configuration
-------------
.. _supybot.plugins.GitHub.api:
supybot.plugins.GitHub.api
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.GitHub.api.url:
supybot.plugins.GitHub.api.url
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: http://github.com/api/v2/json
The URL of the GitHub API to use. You probably don't need to edit it, but I let it there, just in case.
.. _supybot.plugins.GitHub.announces:
supybot.plugins.GitHub.announces
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
You shouldn't edit this configuration variable yourself, unless you know what you do. Use '@Github announce add' or '@Github announce remove' instead.
.. _supybot.plugins.GitHub.public:
supybot.plugins.GitHub.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

44
use/plugins/goodfrench.rst
View File

@ -1,44 +0,0 @@
.. _plugin-goodfrench:
The GoodFrench plugin
=====================
.. include:: unofficial.inc
Command
-------
.. _command-goodfrench-detect:
goodfrench detect <texte>
^^^^^^^^^^^^^^^^^^^^^^^^^
Cherche des fautes dans le *<texte>*, en fonction de la valeur locale de
:ref:`supybot.plugins.GoodFrench.level.`
.. _plugin-goodfrench-config:
Configuration
-------------
.. _supybot.plugins.GoodFrench.level:
supybot.plugins.GoodFrench.level
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 0
Le niveau de filtrage. Le niveau N filtre ce que le niveau N-1 filtrait, avec des choses en plus. 0 : pas de filtrage ; 1 : filtre le langage SMS 2 : filtre les erreurs de pluriel ; 3 : filtre les fautes de conjugaison courantes ; 4 : filtre les fautes d'orthographe courantes ; 5 : filtre les abbréviations ("t'as" au lieu de "tu as") ; 6 : filtre les 'lol' 7 : filtre les erreurs de typographie (note : a tendance à avoir la gachette facile)
.. _supybot.plugins.GoodFrench.public:
supybot.plugins.GoodFrench.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

146
use/plugins/google.rst
View File

@ -1,146 +0,0 @@
.. _plugin-google:
The Google plugin
=================
Web search
----------
.. _command-google-google:
google google <search> [--{filter,language} <value>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches google.com for the given string. As many results as can fit
are included. *--language* accepts a language abbreviation; *--filter
accepts* a filtering level ('active', 'moderate', 'off').
.. _command-google-cache:
google cache <url>
^^^^^^^^^^^^^^^^^^
Returns a link to the cached version of *<url>* if it is available.
.. _command-google-lucky:
google 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-fight:
google fight <search string> <search string> [<search string> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the results of each search, in order, from greatest number
of results to least.
Others
------
.. _command-google-phonebook:
google phonebook <phone number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks *<phone number>* up on Google.
.. _command-google-calc:
google calc <expression>
^^^^^^^^^^^^^^^^^^^^^^^^
Uses Google's calculator to calculate the value of *<expression>*.
.. _command-google-translate:
google translate <from-language> [to] <to-language> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* translated from *<from-language>* into *<to-language>*.
Beware that translating to or from languages that use multi-byte
characters may result in some very odd results.
.. _plugin-google-config:
Configuration
-------------
.. _supybot.plugins.Google.bold:
supybot.plugins.Google.bold
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether results are bolded.
.. _supybot.plugins.Google.colorfulFilter:
supybot.plugins.Google.colorfulFilter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the word 'google' in the bot's output will be made colorful (like Google's logo).
.. _supybot.plugins.Google.defaultLanguage:
supybot.plugins.Google.defaultLanguage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: lang_en
Determines what default language is used in searches. If left empty, no specific language will be requested.
.. _supybot.plugins.Google.maximumResults:
supybot.plugins.Google.maximumResults
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 8
Determines the maximum number of results returned from the google command.
.. _supybot.plugins.Google.searchFilter:
supybot.plugins.Google.searchFilter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: moderate
Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering
.. _supybot.plugins.Google.searchSnarfer:
supybot.plugins.Google.searchSnarfer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the search snarfer is enabled. If so, messages (even unaddressed ones) beginning with the word 'google' will result in the first URL Google returns being sent to the channel.
.. _supybot.plugins.Google.public:
supybot.plugins.Google.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.Google.referer:
supybot.plugins.Google.referer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
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

42
use/plugins/gui.rst
View File

@ -1,42 +0,0 @@
.. _plugin-gui:
The GUI plugin
==============
.. include:: unofficial.inc
.. _plugin-gui-config:
Configuration
-------------
.. _supybot.plugins.GUI.host:
supybot.plugins.GUI.host
^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 127.0.0.1
The host the server will bind.
.. _supybot.plugins.GUI.port:
supybot.plugins.GUI.port
^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14789
The port the server will bind.
.. _supybot.plugins.GUI.public:
supybot.plugins.GUI.public
^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

150
use/plugins/herald.rst
View File

@ -1,150 +0,0 @@
.. _plugin-herald:
The Herald plugin
=================
User commands
-------------
.. _command-herald-get:
herald get [<channel>] [<user|nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current herald message for *<user>* (or the user
*<nick|hostmask>* is currently identified or recognized as). If *<user>*
is not given, defaults to the user giving the command. *<channel>*
is only necessary if the message isn't sent in the channel itself.
.. _command-herald-remove:
herald remove [<channel>] [<user|nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the herald message set for *<user>*, or the user
*<nick|hostmask>* is currently identified or recognized as. If *<user>*
is not given, defaults to the user giving the command.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-herald-change:
herald change [<channel>] [<user|nick>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes the herald message for *<user>*, or the user *<nick|hostmask>* is
currently identified or recognized as, according to *<regexp>*. If
*<user>* is not given, defaults to the calling user. *<channel>* is only
necessary if the message isn't sent in the channel itself.
Op commands
-----------
.. _command-herald-default:
herald default [<channel>] [--remove|<msg>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If *<msg>* is given, sets the default herald to *<msg>*. A *<msg>* of ""
will remove the default herald. If *<msg>* is not given, returns the
current default herald. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-herald-add:
herald add [<channel>] <user|nick> <msg>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the herald message for *<user>* (or the user *<nick|hostmask>* is
currently identified or recognized as) to *<msg>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _plugin-herald-config:
Configuration
-------------
.. _supybot.plugins.Herald.heralding:
supybot.plugins.Herald.heralding
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether messages will be sent to the channel when a recognized user joins; basically enables or disables the plugin.
.. _supybot.plugins.Herald.default:
supybot.plugins.Herald.default
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
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.
.. _supybot.plugins.Herald.default.notice:
supybot.plugins.Herald.default.notice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the default herald will be sent as a NOTICE instead of a PRIVMSG.
.. _supybot.plugins.Herald.default.public:
supybot.plugins.Herald.default.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the default herald will be sent publicly.
.. _supybot.plugins.Herald.throttle:
supybot.plugins.Herald.throttle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 600
Determines the minimum number of seconds between heralds.
.. _supybot.plugins.Herald.throttle.afterPart:
supybot.plugins.Herald.throttle.afterPart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 0
Determines the minimum number of seconds after parting that the bot will not herald the person when he or she rejoins.
.. _supybot.plugins.Herald.throttle.afterSplit:
supybot.plugins.Herald.throttle.afterSplit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 60
Determines the minimum number of seconds after a netsplit that the bot will not herald the users that split.
.. _supybot.plugins.Herald.public:
supybot.plugins.Herald.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.Herald.requireCapability:
supybot.plugins.Herald.requireCapability
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what capability (if any) is required to add/change/remove the herald of another user.

135
use/plugins/index.rst
View File

@ -1,135 +0,0 @@
.. _main-plugins:
***************
Supybot plugins
***************
Main plugins
============
.. toctree::
:maxdepth: 3
admin.rst
channel.rst
config.rst
misc.rst
network.rst
owner.rst
plugin.rst
user.rst
Channel-specific plugins
========================
.. toctree::
:maxdepth: 3
automode.rst
attackprotector.rst
badwords.rst
channellogger.rst
channelstats.rst
factoids.rst
herald.rst
karma.rst
lart.rst
limiter.rst
linkrelay.rst
moobotfactoids.rst
protector.rst
topic.rst
webstats.rst
Utilities
=========
.. toctree::
:maxdepth: 3
anonymous.rst
ctcp.rst
debian.rst
goodfrench.rst
later.rst
news.rst
nickcapture.rst
note.rst
relay.rst
rss.rst
seen.rst
services.rst
seeks.rst
shrinkurl.rst
string.rst
wikitrans.rst
Internal tools
===============
.. toctree::
:maxdepth: 3
alias.rst
dunno.rst
format.rst
plugindownloader.rst
reply.rst
scheduler.rst
success.rst
sudo.rst
trigger.rst
utilities.rst
Scripting/programming
=====================
.. toctree::
:maxdepth: 3
brainfuck.rst
conditional.rst
messageparser.rst
supyml.rst
supysandbox.rst
Fun
===
.. toctree::
:maxdepth: 3
coffee.rst
erepublik.rst
eureka.rst
filter.rst
games.rst
megahal.rst
nickometer.rst
praise.rst
quote.rst
quotegrabs.rst
timebomb.rst
trivia.rst
Other plugins
=============
.. toctree::
:maxdepth: 3
dict.rst
google.rst
github.rst
gui.rst
internet.rst
math.rst
status.rst
time.rst
todo.rst
twitter.rst
unix.rst
url.rst
web.rst
wikipedia.rst

46
use/plugins/internet.rst
View File

@ -1,46 +0,0 @@
.. _plugin-internet:
The Internet plugin
===================
Commands
--------
.. _command-internet-whois:
internet whois <domain>
^^^^^^^^^^^^^^^^^^^^^^^
Returns WHOIS information on the registration of *<domain>*.
.. _command-internet-dns:
internet dns <host|ip>
^^^^^^^^^^^^^^^^^^^^^^
Returns the ip of *<host>* or the reverse DNS hostname of *<ip>*.
.. _command-internet-hexip:
internet hexip <ip>
^^^^^^^^^^^^^^^^^^^
Returns the hexadecimal IP for that IP.
.. _plugin-internet-config:
Configuration
-------------
.. _supybot.plugins.Internet.public:
supybot.plugins.Internet.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

128
use/plugins/karma.rst
View File

@ -1,128 +0,0 @@
.. _plugin-karma:
The Karma plugin
================
Main commands
-------------
.. _command-karma-clear:
karma clear [<channel>] <name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Resets the karma of *<name>* to 0.
.. _command-karma-most:
karma most [<channel>] {increased,decreased,active}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the most increased, the most decreased, or the most active
(the sum of increased and decreased) karma things. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-karma-karma:
karma karma [<channel>] [<thing> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the karma of *<thing>*. If *<thing>* is not given, returns the top
N karmas, where N is determined by the config variable
:ref:`supybot.plugins.Karma.rankingDisplay.` If one *<thing>* is given, returns
the details of its karma; if more than one *<thing>* is given, returns
the total karma of each of the the things. *<channel>* is only necessary
if the message isn't sent on the channel itself.
Maintenance
-----------
.. _command-karma-load:
karma load [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Loads the Karma database for *<channel>* from *<filename>* in the bot's
data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.
.. _command-karma-dump:
karma dump [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Dumps the Karma database for *<channel>* to *<filename>* in the bot's
data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.
.. _plugin-karma-config:
Configuration
-------------
.. _supybot.plugins.Karma.allowSelfRating:
supybot.plugins.Karma.allowSelfRating
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether users can adjust the karma of their nick.
.. _supybot.plugins.Karma.allowUnaddressedKarma:
supybot.plugins.Karma.allowUnaddressedKarma
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will increase/decrease karma without being addressed.
.. _supybot.plugins.Karma.mostDisplay:
supybot.plugins.Karma.mostDisplay
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 25
Determines how many karma things are shown when the most command is called.
.. _supybot.plugins.Karma.rankingDisplay:
supybot.plugins.Karma.rankingDisplay
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 3
Determines how many highest/lowest karma things are shown when karma is called with no arguments.
.. _supybot.plugins.Karma.response:
supybot.plugins.Karma.response
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will reply with a success message when something's karma is increased or decreased.
.. _supybot.plugins.Karma.simpleOutput:
supybot.plugins.Karma.simpleOutput
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will output shorter versions of the karma output when requesting a single thing's karma.
.. _supybot.plugins.Karma.public:
supybot.plugins.Karma.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

43
use/plugins/lart.rst
View File

@ -1,43 +0,0 @@
.. _plugin-lart:
The Lart plugin
===============
Command
-------
.. _command-lart-lart:
lart lart [<channel>] [<id>] <who|what> [for <reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Uses the Luser Attitude Readjustment Tool on *<who|what>* (for *<reason>*,
if given). If *<id>* is given, uses that specific lart. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _plugin-lart-config:
Configuration
-------------
.. _supybot.plugins.Lart.showIds:
supybot.plugins.Lart.showIds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will show the ids of a lart when the lart is given.
.. _supybot.plugins.Lart.public:
supybot.plugins.Lart.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

85
use/plugins/later.rst
View File

@ -1,85 +0,0 @@
.. _plugin-later:
The Later plugin
================
Commands
--------
.. _command-later-notes:
later notes [<nick>]
^^^^^^^^^^^^^^^^^^^^
If *<nick>* is given, replies with what notes are waiting on *<nick>*,
otherwise, replies with the nicks that have notes waiting for them.
.. _command-later-remove:
later remove <nick>
^^^^^^^^^^^^^^^^^^^
Removes the notes waiting on *<nick>*.
.. _command-later-tell:
later tell <nick> <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Tells *<nick>* *<text>* the next time *<nick>* is in seen. *<nick>* can
contain wildcard characters, and the first matching nick will be
given the note.
.. _plugin-later-config:
Configuration
-------------
.. _supybot.plugins.Later.maximum:
supybot.plugins.Later.maximum
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 0
Determines the maximum number of messages to be queued for a user. If this value is 0, there is no maximum.
.. _supybot.plugins.Later.messageExpiry:
supybot.plugins.Later.messageExpiry
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 30
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.
.. _supybot.plugins.Later.private:
supybot.plugins.Later.private
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether users will be notified in the first place in which they're seen, or in private.
.. _supybot.plugins.Later.public:
supybot.plugins.Later.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.Later.tellOnJoin:
supybot.plugins.Later.tellOnJoin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether users will be notified upon joining any channel the bot is in, or only upon sending a message.

49
use/plugins/limiter.rst
View File

@ -1,49 +0,0 @@
.. _plugin-limiter:
The Limiter plugin
==================
.. _plugin-limiter-config:
Configuration
-------------
.. _supybot.plugins.Limiter.enable:
supybot.plugins.Limiter.enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
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.
.. _supybot.plugins.Limiter.maximumExcess:
supybot.plugins.Limiter.maximumExcess
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 10
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.
.. _supybot.plugins.Limiter.minimumExcess:
supybot.plugins.Limiter.minimumExcess
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 5
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.
.. _supybot.plugins.Limiter.public:
supybot.plugins.Limiter.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

229
use/plugins/linkrelay.rst
View File

@ -1,229 +0,0 @@
.. _plugin-linkrelay:
The LinkRelay plugin
====================
.. include:: unofficial.inc
Manage relays
-------------
.. _command-linkrelay-add:
linkrelay add [--from <channel>@<network>] [--to <channel>@<network>] [--regexp <regexp>] [--reciprocal]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds a relay to the list. You must give at least *--from* or *--to;* if
one of them is not given, it defaults to the current channel@network.
Only messages matching *<regexp>* will be relayed; if *<regexp>* is not
given, everything is relayed.
If *--reciprocal* is given, another relay will be added automatically,
in the opposite direction.
.. _command-linkrelay-remove:
linkrelay remove [--from <channel>@<network>] [--to <channel>@<network>] [--regexp <regexp>] [--reciprocal]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove a relay from the list. You must give at least *--from* or *--to;* if
one of them is not given, it defaults to the current channel@network.
Only messages matching *<regexp>* will be relayed; if *<regexp>* is not
given, everything is relayed.
If *--reciprocal* is given, another relay will be removed automatically,
in the opposite direction.
.. _command-linkrelay-list:
linkrelay list
^^^^^^^^^^^^^^
Returns all the defined relay links
Substitutes
-----------
.. _command-linkrelay-substitute:
linkrelay substitute <regexp> <replacement>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replaces all nicks that matches the *<regexp>* by the *<replacement>*
string.
.. _command-linkrelay-nosubstitute:
linkrelay nosubstitute <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Undo a substitution.
.. _command-linkrelay-nicks:
linkrelay nicks [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the nicks of the people in the linked channels.
*<channel>* is only necessary if the message
isn't sent on the channel itself.
.. _plugin-linkrelay-config:
Configuration
-------------
.. _supybot.plugins.LinkRelay.color:
supybot.plugins.LinkRelay.color
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will color Relayed PRIVMSGs so as to make the messages easier to read.
.. _supybot.plugins.LinkRelay.hostmasks:
supybot.plugins.LinkRelay.hostmasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will Relay the hostmask of the person joining or parting the channel when he or she joins or parts.
.. _supybot.plugins.LinkRelay.includeNetwork:
supybot.plugins.LinkRelay.includeNetwork
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
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.
.. _supybot.plugins.LinkRelay.nonPrivmsgs:
supybot.plugins.LinkRelay.nonPrivmsgs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: privmsg
Determines whether the bot will use PRIVMSGs (privmsg), NOTICEs (notice), for non-PRIVMSG Relay messages (i.e., joins, parts, nicks, quits, modes, etc.), or whether it won't relay such messages (nothing)
.. _supybot.plugins.LinkRelay.topicSync:
supybot.plugins.LinkRelay.topicSync
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will synchronize topics between networks in the channels it Relays.
.. _supybot.plugins.LinkRelay.colors:
supybot.plugins.LinkRelay.colors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.LinkRelay.colors.info:
supybot.plugins.LinkRelay.colors.info
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 02
Color used for relaying 02.
.. _supybot.plugins.LinkRelay.colors.join:
supybot.plugins.LinkRelay.colors.join
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.kick:
supybot.plugins.LinkRelay.colors.kick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.mode:
supybot.plugins.LinkRelay.colors.mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.nick:
supybot.plugins.LinkRelay.colors.nick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.part:
supybot.plugins.LinkRelay.colors.part
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.quit:
supybot.plugins.LinkRelay.colors.quit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.truncated:
supybot.plugins.LinkRelay.colors.truncated
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.public:
supybot.plugins.LinkRelay.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.LinkRelay.relays:
supybot.plugins.LinkRelay.relays
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
You shouldn't edit this configuration variable yourself unless you know what you do. Use @LinkRelay {add|remove} instead.
.. _supybot.plugins.LinkRelay.substitutes:
supybot.plugins.LinkRelay.substitutes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
You shouldn't edit this configuration variable yourself unless you know what you do. Use @LinkRelay (no)substitute instead.

80
use/plugins/math.rst
View File

@ -1,80 +0,0 @@
.. _plugin-math:
The Math plugin
===============
Conversion
----------
.. _command-math-base:
math base <fromBase> [<toBase>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Converts *<number>* from base *<fromBase>* to base *<toBase>*.
If *<toBase>* is left out, it converts to decimal.
.. _command-math-convert:
math convert [<number>] <unit> to <other unit>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Converts from *<unit>* to *<other unit>*. If number isn't given, it
defaults to 1. For unit information, see 'units' command.
Calculation
-----------
.. _command-math-rpn:
math rpn <rpn math expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the value of an RPN expression.
.. _command-math-icalc:
math icalc <math expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This is the same as the calc command except that it allows integer
math, and can thus cause the bot to suck up CPU. Hence it requires
the 'trusted' capability to use.
.. _command-math-units:
math units [<type>]
^^^^^^^^^^^^^^^^^^^
With no arguments, returns a list of measurement types, which can be
passed as arguments. When called with a type as an argument, returns
the units of that type.
.. _command-math-calc:
math calc <math expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the value of the evaluated *<math expression>*. The syntax is
Python syntax; the type of arithmetic is floating point. Floating
point arithmetic is used in order to prevent a user from being able to
crash to the bot with something like '10**10**10**10'. One consequence
is that large values such as '10**24' might not be exact.
.. _plugin-math-config:
Configuration
-------------
.. _supybot.plugins.Math.public:
supybot.plugins.Math.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

171
use/plugins/messageparser.rst
View File

@ -1,171 +0,0 @@
.. _plugin-messageparser:
The MessageParser plugin
========================
Administration
--------------
.. _command-messageparser-remove:
messageparser remove [<channel>] [--id] <regexp>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the trigger for *<regexp>* from the triggers database.
*<channel>* is only necessary if
the message isn't sent in the channel itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-add:
messageparser add [<channel>] <regexp> <action>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Associates *<regexp>* with *<action>*. *<channel>* is only
necessary if the message isn't sent on the channel
itself. Action is echoed upon regexp match, with variables $1, $2,
etc. being interpolated from the regexp match groups.
.. _command-messageparser-lock:
messageparser lock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Locks the *<regexp>* so that it cannot be
removed or overwritten to. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-messageparser-unlock:
messageparser unlock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the entry associated with *<regexp>* so that it can be
removed or overwritten. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-messageparser-vacuum:
messageparser vacuum [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Vacuums the database for *<channel>*.
See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html
*<channel>* is only necessary if the message isn't sent in
the channel itself.
First check if user has the required capability specified in plugin
config requireVacuumCapability.
User commands
-------------
.. _command-messageparser-show:
messageparser show [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the value of *<regexp>* in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-rank:
messageparser rank [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a list of top-ranked regexps, sorted by usage count
(rank). The number of regexps returned is set by the
rankListLength registry value. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-messageparser-info:
messageparser info [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Display information about *<regexp>* in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-list:
messageparser list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists regexps present in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel
itself. Regexp ID listed in paretheses.
.. _plugin-messageparser-config:
Configuration
-------------
.. _supybot.plugins.MessageParser.enable:
supybot.plugins.MessageParser.enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the message parser is enabled. If enabled, will trigger on regexps added to the regexp db.
.. _supybot.plugins.MessageParser.keepRankInfo:
supybot.plugins.MessageParser.keepRankInfo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether we keep updating the usage count for each regexp, for popularity ranking.
.. _supybot.plugins.MessageParser.listSeparator:
supybot.plugins.MessageParser.listSeparator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: ,
Determines the separator used between regexps when shown by the list command.
.. _supybot.plugins.MessageParser.rankListLength:
supybot.plugins.MessageParser.rankListLength
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 20
Determines the number of regexps returned by the triggerrank command.
.. _supybot.plugins.MessageParser.requireManageCapability:
supybot.plugins.MessageParser.requireManageCapability
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: admin; channel,op
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.
.. _supybot.plugins.MessageParser.requireVacuumCapability:
supybot.plugins.MessageParser.requireVacuumCapability
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: admin
Determines the capability required (if any) to vacuum the database.
.. _supybot.plugins.MessageParser.public:
supybot.plugins.MessageParser.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

170
use/plugins/misc.rst
View File

@ -1,170 +0,0 @@
.. _plugin-misc:
The Misc plugin
===============
Main commands
-------------
.. _command-misc-help:
misc help [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This command gives a useful description of what *<command>* does.
*<plugin>* is only necessary if the command is in more than one plugin.
.. _command-misc-list:
misc list [--private] [<plugin>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the commands available in the given plugin. If no plugin is
given, lists the public plugins available. If *--private* is given,
lists the private plugins.
.. _command-misc-more:
misc more [<nick>]
^^^^^^^^^^^^^^^^^^
If the last command was truncated due to IRC message length
limitations, returns the next chunk of the result of the last command.
If *<nick>* is given, it takes the continuation of the last command from
*<nick>* instead of the person sending this message.
Utilities
---------
.. _command-misc-last:
misc last [--{from,in,on,with,without,regexp} <value>] [--nolimit]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last message matching the given criteria. *--from* requires
a nick from whom the message came; *--in* requires a channel the message
was sent to; *--on* requires a network the message was sent on; *--with
requires* some string that had to be in the message; *--regexp* requires
a regular expression the message must match; *--nolimit* returns all
the messages that can be found. By default, the channel this command is
given in is searched.
.. _command-misc-ping:
misc ping
^^^^^^^^^
Checks to see if the bot is alive.
.. _command-misc-tell:
misc tell <nick> <text>
^^^^^^^^^^^^^^^^^^^^^^^
Tells the *<nick>* whatever *<text>* is. Use nested commands to your
benefit here.
Getting informations about the bot
----------------------------------
.. _command-misc-source:
misc source
^^^^^^^^^^^
Returns a URL saying where to get Supybot.
.. _command-misc-version:
misc version
^^^^^^^^^^^^
Returns the version of the current bot.
.. _command-misc-apropos:
misc apropos <string>
^^^^^^^^^^^^^^^^^^^^^
Searches for *<string>* in the commands currently offered by the bot,
returning a list of the commands containing that string.
.. _plugin-misc-config:
Configuration
-------------
.. _supybot.plugins.Misc.last:
supybot.plugins.Misc.last
^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Misc.last.nested:
supybot.plugins.Misc.last.nested
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Misc.last.nested.includeNick:
supybot.plugins.Misc.last.nested.includeNick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether or not the nick will be included in the output of last when it is part of a nested command
.. _supybot.plugins.Misc.last.nested.includeTimestamp:
supybot.plugins.Misc.last.nested.includeTimestamp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether or not the timestamp will be included in the output of last when it is part of a nested command
.. _supybot.plugins.Misc.listPrivatePlugins:
supybot.plugins.Misc.listPrivatePlugins
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
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.
.. _supybot.plugins.Misc.listUnloadedPlugins:
supybot.plugins.Misc.listUnloadedPlugins
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
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.
.. _supybot.plugins.Misc.public:
supybot.plugins.Misc.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.Misc.timestampFormat:
supybot.plugins.Misc.timestampFormat
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: [%H:%M:%S]
Determines the format string for timestamps in the Misc.last command. Refer to the Python documentation for the time module to see what formats are accepted. If you set this variable to the empty string, the timestamp will not be shown.

138
use/plugins/moobotfactoids.rst
View File

@ -1,138 +0,0 @@
.. _plugin-moobotfactoids:
The MoobotFactoids plugin
=========================
Reading factoids
----------------
.. _command-moobotfactoids-listauth:
moobotfactoids listauth [<channel>] <author name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the keys of the factoids with the given author. Note that if an
author has an integer name, you'll have to use that author's id to use
this function (so don't use integer usernames!). *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-moobotfactoids-random:
moobotfactoids random [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Displays a random factoid (along with its key) from the database.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-moobotfactoids-literal:
moobotfactoids literal [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the literal factoid for the given factoid key. No parsing of
the factoid value is done as it is with normal retrieval. *<channel>*
is only necessary if the message isn't sent in the channel itself.
.. _command-moobotfactoids-listvalues:
moobotfactoids listvalues [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the keys of the factoids whose value contains the provided text.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-moobotfactoids-factinfo:
moobotfactoids factinfo [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the various bits of info on the factoid for the given key.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-moobotfactoids-most:
moobotfactoids most [<channel>] {popular|authored|recent}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the most *{popular|authored|recent}* factoids. "popular" lists the
most frequently requested factoids. "authored" lists the author with
the most factoids. "recent" lists the most recently created factoids.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-moobotfactoids-listkeys:
moobotfactoids listkeys [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the keys of the factoids whose key contains the provided text.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
Administration
--------------
.. _command-moobotfactoids-lock:
moobotfactoids lock [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Locks the factoid with the given factoid key. Requires that the user
be registered and have created the factoid originally. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-moobotfactoids-unlock:
moobotfactoids unlock [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the factoid with the given factoid key. Requires that the
user be registered and have locked the factoid. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-moobotfactoids-remove:
moobotfactoids remove [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Deletes the factoid with the given key. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _plugin-moobotfactoids-config:
Configuration
-------------
.. _supybot.plugins.MoobotFactoids.mostCount:
supybot.plugins.MoobotFactoids.mostCount
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 10
Determines how many items are shown when the 'most' command is called.
.. _supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch:
supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether or not the factoid value will be shown when a listkeys search returns only one factoid key.
.. _supybot.plugins.MoobotFactoids.public:
supybot.plugins.MoobotFactoids.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

103
use/plugins/network.rst
View File

@ -1,103 +0,0 @@
.. _plugin-network:
The Network plugin
==================
Getting status
--------------
.. _command-network-driver:
network driver [<network>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current network driver for *<network>*. *<network>* is only
necessary if the message isn't sent on the network to which this
command is to apply.
.. _command-network-networks:
network networks
^^^^^^^^^^^^^^^^
Returns the networks to which the bot is currently connected.
.. _command-network-latency:
network latency [<network>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current latency to *<network>*. *<network>* is only necessary
if the message isn't sent on the network to which this command is to
apply.
Running commands
----------------
.. _command-network-whois:
network whois [<network>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the WHOIS response *<network>* gives for *<nick>*. *<network>* is
only necessary if the network is different than the network the command
is sent on.
.. _command-network-command:
network command <network> <command> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the bot *<command>* (with its associated *<arg>*s) on *<network>*.
(Dis)connecting
---------------
.. _command-network-connect:
network connect [--ssl] <network> [<host[:port]>] [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Connects to another network (which will be represented by the name
provided in *<network>*) at *<host:port>*. If port is not provided, it
defaults to 6667, the default port for IRC. If password is
provided, it will be sent to the server in a PASS command. If *--ssl* is
provided, an SSL connection will be attempted.
.. _command-network-reconnect:
network reconnect [<network>] [<quit message>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Disconnects and then reconnects to *<network>*. If no network is given,
disconnects and then reconnects to the network the command was given
on. If no quit message is given, uses the configured one
(:ref:`supybot.plugins.Owner.quitMsg`) or the nick of the person giving the
command.
.. _command-network-disconnect:
network disconnect [<network>] [<quit message>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Disconnects from the network represented by the network *<network>*.
If *<quit message>* is given, quits the network with the given quit
message. *<network>* is only necessary if the network is different
from the network the command is sent on.
.. _plugin-network-config:
Configuration
-------------
.. _supybot.plugins.Network.public:
supybot.plugins.Network.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

75
use/plugins/news.rst
View File

@ -1,75 +0,0 @@
.. _plugin-news:
The News plugin
===============
Read news
---------
.. _command-news-old:
news old [<channel>] [<id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the old news item for *<channel>* with *<id>*. If no number is
given, returns all the old news items in reverse order. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-news-news:
news news [<channel>] [<id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Display the news items for *<channel>* in the format of '(#id) subject'.
If *<id>* is given, retrieve only that news item; otherwise retrieve all
news items. *<channel>* is only necessary if the message isn't sent in
the channel itself.
Administration
--------------
.. _command-news-remove:
news remove [<channel>] <id>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the news item with *<id>* from *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-news-add:
news add [<channel>] <expires> <subject>: <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds a given news item of *<text>* to a channel with the given *<subject>*.
If *<expires>* isn't 0, that news item will expire *<expires>* seconds from
now. *<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-news-change:
news change [<channel>] <id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes the news item with *<id>* from *<channel>* according to the
regular expression *<regexp>*. *<regexp>* should be of the form
s/text/replacement/flags. *<channel>* is only necessary if the message
isn't sent on the channel itself.
.. _plugin-news-config:
Configuration
-------------
.. _supybot.plugins.News.public:
supybot.plugins.News.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

40
use/plugins/nickcapture.rst
View File

@ -1,40 +0,0 @@
.. _plugin-nickcapture:
The NickCapture plugin
======================
.. _plugin-nickcapture-config:
Configuration
-------------
.. _supybot.plugins.NickCapture.ison:
supybot.plugins.NickCapture.ison
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will check occasionally if its preferred nick is in use via the ISON command.
.. _supybot.plugins.NickCapture.ison.period:
supybot.plugins.NickCapture.ison.period
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 600
Determines how often (in seconds) the bot will check whether its nick ISON.
.. _supybot.plugins.NickCapture.public:
supybot.plugins.NickCapture.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

33
use/plugins/nickometer.rst
View File

@ -1,33 +0,0 @@
.. _plugin-nickometer:
The Nickometer plugin
=====================
Command
-------
.. _command-nickometer-nickometer:
nickometer nickometer [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Tells you how lame said nick is. If *<nick>* is not given, uses the
nick of the person giving the command.
.. _plugin-nickometer-config:
Configuration
-------------
.. _supybot.plugins.Nickometer.public:
supybot.plugins.Nickometer.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

121
use/plugins/note.rst
View File

@ -1,121 +0,0 @@
.. _plugin-note:
The Note plugin
===============
Reading notes
-------------
.. _command-note-search:
note search [--{regexp} <value>] [--sent] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches your received notes for ones matching *<glob>*. If *--regexp* is
given, its associated value is taken as a regexp and matched against
the notes. If *--sent* is specified, only search sent notes.
.. _command-note-list:
note list [--{old,sent}] [--{from,to} <user>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Retrieves the ids of all your unread notes. If *--old* is given, list
read notes. If *--sent* is given, list notes that you have sent. If
*--from* is specified, only lists notes sent to you from *<user>*. If
*--to* is specified, only lists notes sent by you to *<user>*.
.. _command-note-next:
note next
^^^^^^^^^
Retrieves your next unread note, if any.
.. _command-note-note:
note note <id>
^^^^^^^^^^^^^^
Retrieves a single note by its unique note id. Use the 'note list'
command to see what unread notes you have.
Sending notes
-------------
.. _command-note-unsend:
note unsend <id>
^^^^^^^^^^^^^^^^
Unsends the note with the id given. You must be the
author of the note, and it must be unread.
.. _command-note-reply:
note reply <id> <text>
^^^^^^^^^^^^^^^^^^^^^^
Sends a note in reply to *<id>*.
.. _command-note-send:
note send <recipient>,[<recipient>,[...]] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sends a new note to the user specified. Multiple recipients may be
specified by separating their names by commas.
.. _plugin-note-config:
Configuration
-------------
.. _supybot.plugins.Note.notify:
supybot.plugins.Note.notify
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Note.notify.onJoin:
supybot.plugins.Note.notify.onJoin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will notify people of their new messages when they join the channel. Normally it will notify them when they send a message to the channel, since oftentimes joins are the result of netsplits and not the actual presence of the user.
.. _supybot.plugins.Note.notify.onJoin.repeatedly:
supybot.plugins.Note.notify.onJoin.repeatedly
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will repeatedly notify people of their new messages when they join the channel. That means when they join the channel, the bot will tell them they have unread messages, even if it's told them before.
.. _supybot.plugins.Note.notify.autoSend:
supybot.plugins.Note.notify.autoSend
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 0
Determines the upper limit for automatically sending messages instead of notifications. I.e., if this value is 2 and there are 2 new messages to notify a user about, instead of sending a notification message, the bot will simply send those new messages. If there are 3 new messages, however, the bot will send a notification message.
.. _supybot.plugins.Note.public:
supybot.plugins.Note.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

178
use/plugins/owner.rst
View File

@ -1,178 +0,0 @@
.. _plugin-owner:
The Owner plugin
================
Plugins and commands
--------------------
.. _command-owner-load:
owner load [--deprecated] <plugin>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Loads the plugin *<plugin>* from any of the directories in
conf.:ref:`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-unload:
owner unload <plugin>
^^^^^^^^^^^^^^^^^^^^^
Unloads the callback by name; use the 'list' command to see a list
of the currently loaded callbacks. Obviously, the Owner plugin can't
be unloaded.
.. _command-owner-reload:
owner reload <plugin>
^^^^^^^^^^^^^^^^^^^^^
Unloads and subsequently reloads the plugin by name; use the 'list'
command to see a list of the currently loaded plugins.
.. _command-owner-rename:
owner rename <plugin> <command> <new name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Renames *<command>* in *<plugin>* to the *<new name>*.
.. _command-owner-unrename:
owner unrename <plugin>
^^^^^^^^^^^^^^^^^^^^^^^
Removes all renames in *<plugin>*. The plugin will be reloaded after
this command is run.
.. _command-owner-enable:
owner enable [<plugin>] <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Enables the command *<command>* for all users. If *<plugin>*
if given, only enables the *<command>* from *<plugin>*. This command is
the inverse of disable.
.. _command-owner-disable:
owner disable [<plugin>] <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Disables the command *<command>* for all users (including the owners).
If *<plugin>* is given, only disables the *<command>* from *<plugin>*. If
you want to disable a command for most users but not for yourself, set
a default capability of -plugin.command or -command (if you want to
disable the command in all plugins).
.. _command-owner-defaultplugin:
owner defaultplugin [--remove] <command> [<plugin>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the default plugin for *<command>* to *<plugin>*. If *--remove* is
given, removes the current default plugin for *<command>*. If no plugin
is given, returns the current default plugin set for *<command>*. See
also, :ref:`supybot.commands.defaultPlugins.importantPlugins.`
Capabilities
------------
.. _command-owner-defaultcapability:
owner defaultcapability {add|remove} <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds or removes (according to the first argument) *<capability>* from the
default capabilities given to users (the configuration variable
:ref:`supybot.capabilities` stores these).
Maintenance
-----------
.. _command-owner-reloadlocale:
owner reloadlocale takes no argument
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Reloads the locale of the bot.
.. _command-owner-ircquote:
owner ircquote <string to be sent to the server>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sends the raw string given to the server.
.. _command-owner-upkeep:
owner upkeep [<level>]
^^^^^^^^^^^^^^^^^^^^^^
Runs the standard upkeep stuff (flushes and gc.collects()). If given
a level, runs that level of upkeep (currently, the only supported
level is "high", which causes the bot to flush a lot of caches as well
as do normal upkeep stuff.
.. _command-owner-flush:
owner flush
^^^^^^^^^^^
Runs all the periodic flushers in world.flushers. This includes
flushing all logs and all configuration changes to disk.
.. _command-owner-quit:
owner quit [<text>]
^^^^^^^^^^^^^^^^^^^
Exits the bot with the QUIT message *<text>*. If *<text>* is not given,
the default quit message (:ref:`supybot.plugins.Owner.quitMsg`) will be used.
If there is no default quitMsg set, your nick will be used.
.. _command-owner-announce:
owner announce <text>
^^^^^^^^^^^^^^^^^^^^^
Sends *<text>* to all channels the bot is currently on and not
lobotomized in.
.. _command-owner-logmark:
owner logmark <text>
^^^^^^^^^^^^^^^^^^^^
Logs *<text>* to the global Supybot log at critical priority. Useful for
marking logfiles for later searching.
.. _plugin-owner-config:
Configuration
-------------
.. _supybot.plugins.Owner.public:
supybot.plugins.Owner.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.Owner.quitMsg:
supybot.plugins.Owner.quitMsg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what quit message will be used by default. If the quit command is called without a quit message, this will be used. If this value is empty, the nick of the person giving the quit command will be used.

78
use/plugins/plugin.rst
View File

@ -1,78 +0,0 @@
.. _plugin-plugin:
The Plugin plugin
=================
Authorship
----------
.. _command-plugin-contributors:
plugin contributors <plugin> [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with a list of people who made contributions to a given plugin.
If *<nick>* is specified, that person's specific contributions will
be listed. Note: The *<nick>* is the part inside of the parentheses
in the people listing.
.. _command-plugin-author:
plugin author <plugin>
^^^^^^^^^^^^^^^^^^^^^^
Returns the author of *<plugin>*. This is the person you should talk to
if you have ideas, suggestions, or other comments about a given plugin.
Help
----
.. _command-plugin-help:
plugin help <plugin>
^^^^^^^^^^^^^^^^^^^^
Returns a useful description of how to use *<plugin>*, if the plugin has
one.
.. _command-plugin-plugin:
plugin plugin <command>
^^^^^^^^^^^^^^^^^^^^^^^
Returns the name of the plugin that would be used to call *<command>*.
If it is not uniquely determined, returns list of all plugins that
contain *<command>*.
.. _command-plugin-list:
plugin list
^^^^^^^^^^^
Returns a list of the currently loaded plugins.
.. _command-plugin-plugins:
plugin plugins <command>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns the names of all plugins that contain *<command>*.
.. _plugin-plugin-config:
Configuration
-------------
.. _supybot.plugins.Plugin.public:
supybot.plugins.Plugin.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

41
use/plugins/plugindownloader.rst
View File

@ -1,41 +0,0 @@
.. _plugin-plugindownloader:
The PluginDownloader plugin
===========================
Commands
--------
.. _command-plugindownloader-install:
plugindownloader install <repository> <plugin>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Downloads and installs the *<plugin>* from the *<repository>*.
.. _command-plugindownloader-repolist:
plugindownloader repolist [<repository>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Displays the list of plugins in the *<repository>*.
If *<repository>* is not given, returns a list of available
repositories.
.. _plugin-plugindownloader-config:
Configuration
-------------
.. _supybot.plugins.PluginDownloader.public:
supybot.plugins.PluginDownloader.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

43
use/plugins/praise.rst
View File

@ -1,43 +0,0 @@
.. _plugin-praise:
The Praise plugin
=================
Command
-------
.. _command-praise-praise:
praise praise [<channel>] [<id>] <who|what> [for <reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Praises *<who|what>* (for *<reason>*, if given). If *<id>* is given, uses
that specific praise. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _plugin-praise-config:
Configuration
-------------
.. _supybot.plugins.Praise.showIds:
supybot.plugins.Praise.showIds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will show the ids of a praise when the praise is given.
.. _supybot.plugins.Praise.public:
supybot.plugins.Praise.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

41
use/plugins/protector.rst
View File

@ -1,41 +0,0 @@
.. _plugin-protector:
The Protector plugin
====================
Enforces channel capabilities (op/voice).
.. _plugin-protector-config:
Configuration
-------------
.. _supybot.plugins.Protector.enable:
supybot.plugins.Protector.enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is enabled in a given channel.
.. _supybot.plugins.Protector.immune:
supybot.plugins.Protector.immune
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
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.
.. _supybot.plugins.Protector.public:
supybot.plugins.Protector.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

33
use/plugins/quote.rst
View File

@ -1,33 +0,0 @@
.. _plugin-quote:
The Quote plugin
================
Command
-------
.. _command-quote-random:
quote random [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
Returns a random quote from *<channel>*. *<channel>* is only necessary if
the message isn't sent in the channel itself.
.. _plugin-quote-config:
Configuration
-------------
.. _supybot.plugins.Quote.public:
supybot.plugins.Quote.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

125
use/plugins/quotegrabs.rst
View File

@ -1,125 +0,0 @@
.. _plugin-quotegrabs:
The QuoteGrabs plugin
=====================
Getting quotes
--------------
.. _command-quotegrabs-get:
quotegrabs get [<channel>] <id>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Return the quotegrab with the given *<id>*. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-quotegrabs-quote:
quotegrabs quote [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<nick>*'s latest quote grab in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-quotegrabs-random:
quotegrabs random [<channel>] [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a randomly grabbed quote, optionally choosing only from those
quotes grabbed for *<nick>*. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-quotegrabs-list:
quotegrabs list [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a list of shortened quotes that have been grabbed for *<nick>*
as well as the id of each quote. These ids can be used to get the
full quote. *<channel>* is only necessary if the message isn't sent in
the channel itself.
.. _command-quotegrabs-search:
quotegrabs search [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches for *<text>* in a quote. *<channel>* is only necessary if the
message isn't sent in the channel itself.
(Un)quoting
-----------
.. _command-quotegrabs-ungrab:
quotegrabs ungrab [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the grab *<number>* (the last by default) on *<channel>*.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-quotegrabs-grab:
quotegrabs grab [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Grabs a quote from *<channel>* by *<nick>* for the quotegrabs table.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _plugin-quotegrabs-config:
Configuration
-------------
.. _supybot.plugins.QuoteGrabs.randomGrabber:
supybot.plugins.QuoteGrabs.randomGrabber
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will randomly grab possibly-suitable quotes on occasion. The suitability of a given message is determined by ...
.. _supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs:
supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 864000
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.
.. _supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters:
supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 8
Determines the minimum number of characters in a message for it to be considered for random grabbing.
.. _supybot.plugins.QuoteGrabs.randomGrabber.minimumWords:
supybot.plugins.QuoteGrabs.randomGrabber.minimumWords
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 3
Determines the minimum number of words in a message for it to be considered for random grabbing.
.. _supybot.plugins.QuoteGrabs.public:
supybot.plugins.QuoteGrabs.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

136
use/plugins/relay.rst
View File

@ -1,136 +0,0 @@
.. _plugin-relay:
The Relay plugin
================
Commands
--------
.. _command-relay-nicks:
relay nicks [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Returns the nicks of the people in the channel on the various networks
the bot is connected to. *<channel>* is only necessary if the message
isn't sent on the channel itself.
.. _command-relay-join:
relay join [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Starts relaying between the channel *<channel>* on all networks. If on a
network the bot isn't in *<channel>*, he'll join. This commands is
required even if the bot is in the channel on both networks; he won't
relay between those channels unless he's told to join both
channels. If *<channel>* is not given, starts relaying on the channel
the message was sent in.
.. _command-relay-part:
relay part <channel>
^^^^^^^^^^^^^^^^^^^^
Ceases relaying between the channel *<channel>* on all networks. The bot
will part from the channel on all networks in which it is on the
channel.
.. _plugin-relay-config:
Configuration
-------------
.. _supybot.plugins.Relay.color:
supybot.plugins.Relay.color
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will color relayed PRIVMSGs so as to make the messages easier to read.
.. _supybot.plugins.Relay.hostmasks:
supybot.plugins.Relay.hostmasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will relay the hostmask of the person joining or parting the channel when he or she joins or parts.
.. _supybot.plugins.Relay.ignores:
supybot.plugins.Relay.ignores
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
Determines what hostmasks will not be relayed on a channel.
.. _supybot.plugins.Relay.includeNetwork:
supybot.plugins.Relay.includeNetwork
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
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.
.. _supybot.plugins.Relay.noticeNonPrivmsgs:
supybot.plugins.Relay.noticeNonPrivmsgs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will used NOTICEs rather than PRIVMSGs for non-PRIVMSG relay messages (i.e., joins, parts, nicks, quits, modes, etc.)
.. _supybot.plugins.Relay.punishOtherRelayBots:
supybot.plugins.Relay.punishOtherRelayBots
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will detect other bots relaying and respond by kickbanning them.
.. _supybot.plugins.Relay.topicSync:
supybot.plugins.Relay.topicSync
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will synchronize topics between networks in the channels it relays.
.. _supybot.plugins.Relay.channels:
supybot.plugins.Relay.channels
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
Determines which channels the bot will relay in.
.. _supybot.plugins.Relay.channels.joinOnAllNetworks:
supybot.plugins.Relay.channels.joinOnAllNetworks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will always join the channel(s) it relays for on all networks the bot is connected to.
.. _supybot.plugins.Relay.public:
supybot.plugins.Relay.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

64
use/plugins/reply.rst
View File

@ -1,64 +0,0 @@
.. _plugin-reply:
The Reply plugin
================
Commands
--------
.. _command-reply-notice:
reply notice <text>
^^^^^^^^^^^^^^^^^^^
Replies with *<text>* in a notice. Use nested commands to your benefit
here. If you want a private notice, nest the private command.
.. _command-reply-private:
reply private <text>
^^^^^^^^^^^^^^^^^^^^
Replies with *<text>* in private. Use nested commands to your benefit
here.
.. _command-reply-replies:
reply replies <str> [<str> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with each of its arguments *<str>* in separate replies, depending
the configuration of :ref:`supybot.reply.oneToOne.`
.. _command-reply-action:
reply action <text>
^^^^^^^^^^^^^^^^^^^
Replies with *<text>* as an action. use nested commands to your benefit
here.
.. _command-reply-reply:
reply reply <text>
^^^^^^^^^^^^^^^^^^
Replies with *<text>*. Equivalent to the alias, 'echo $nick: $1'.
.. _plugin-reply-config:
Configuration
-------------
.. _supybot.plugins.Reply.public:
supybot.plugins.Reply.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

196
use/plugins/rss.rst
View File

@ -1,196 +0,0 @@
.. _plugin-rss:
The RSS plugin
==============
Reading
-------
.. _command-rss-info:
rss info <url|feed>
^^^^^^^^^^^^^^^^^^^
Returns information from the given RSS feed, namely the title,
URL, description, and last update date, if available.
.. _command-rss-announce-list:
rss announce list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the list of feeds announced in *<channel>*. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-rss-rss:
rss rss <url> [<number of headlines>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gets the title components of the given RSS feed.
If *<number of headlines>* is given, return only that many headlines.
Administration
--------------
.. _command-rss-remove:
rss remove <name>
^^^^^^^^^^^^^^^^^
Removes the command for looking up RSS feeds at *<name>* from
this plugin.
.. _command-rss-add:
rss add <name> <url>
^^^^^^^^^^^^^^^^^^^^
Adds a command to this plugin that will look up the RSS feed at the
given URL.
.. _command-rss-announce-remove:
rss announce remove [<channel>] <name|url> [<name|url> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the list of feeds from the current list of announced feeds
in *<channel>*. Valid feeds include the names of registered feeds as
well as URLs for RSS feeds. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-rss-announce-add:
rss announce add [<channel>] <name|url> [<name|url> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds the list of feeds to the current list of announced feeds in
*<channel>*. Valid feeds include the names of registered feeds as
well as URLs for RSS feeds. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _plugin-rss-config:
Configuration
-------------
.. _supybot.plugins.RSS.announcementPrefix:
supybot.plugins.RSS.announcementPrefix
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: New news from
Determines what prefix is prepended (if any) to the new news item announcements made in the channel.
.. _supybot.plugins.RSS.bold:
supybot.plugins.RSS.bold
^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will bold the title of the feed when it announces new news.
.. _supybot.plugins.RSS.headlineSeparator:
supybot.plugins.RSS.headlineSeparator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: ||
Determines what string is used to separate headlines in new feeds.
.. _supybot.plugins.RSS.initialAnnounceHeadlines:
supybot.plugins.RSS.initialAnnounceHeadlines
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 5
Indicates how many headlines an rss feed will output when it is first added to announce for a channel.
.. _supybot.plugins.RSS.keywordBlacklist:
supybot.plugins.RSS.keywordBlacklist
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
Space separated list of strings, lets you filter headlines to those not containing any items in this blacklist.
.. _supybot.plugins.RSS.keywordWhitelist:
supybot.plugins.RSS.keywordWhitelist
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
Space separated list of strings, lets you filter headlines to those containing one or more items in this whitelist.
.. _supybot.plugins.RSS.showLinks:
supybot.plugins.RSS.showLinks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will list the link along with the title of the feed when the rss command is called. supybot.plugins.RSS.announce.showLinks affects whether links will be listed when a feed is automatically announced.
.. _supybot.plugins.RSS.announce:
supybot.plugins.RSS.announce
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
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.
.. _supybot.plugins.RSS.announce.showLinks:
supybot.plugins.RSS.announce.showLinks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will list the link along with the title of the feed when a feed is automatically announced.
.. _supybot.plugins.RSS.defaultNumberOfHeadlines:
supybot.plugins.RSS.defaultNumberOfHeadlines
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 1
Indicates how many headlines an rss feed will output by default, if no number is provided.
.. _supybot.plugins.RSS.feeds:
supybot.plugins.RSS.feeds
^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
Determines what feeds should be accessible as commands.
.. _supybot.plugins.RSS.public:
supybot.plugins.RSS.public
^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.RSS.waitPeriod:
supybot.plugins.RSS.waitPeriod
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 1800
Indicates how many seconds the bot will wait between retrieving RSS feeds; requests made within this period will return cached results.

60
use/plugins/scheduler.rst
View File

@ -1,60 +0,0 @@
.. _plugin-scheduler:
The Scheduler plugin
====================
Commands
--------
.. _command-scheduler-repeat:
scheduler repeat <name> <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Schedules the command *<command>* to run every *<seconds>* seconds,
starting now (i.e., the command runs now, and every *<seconds>* seconds
thereafter). *<name>* is a name by which the command can be
unscheduled.
.. _command-scheduler-list:
scheduler list
^^^^^^^^^^^^^^
Lists the currently scheduled events.
.. _command-scheduler-add:
scheduler add <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Schedules the command string *<command>* to run *<seconds>* seconds in the
future. For example, 'scheduler add [seconds 30m] "echo [cpu]"' will
schedule the command "cpu" to be sent to the channel the schedule add
command was given in (with no prefixed nick, a consequence of using
echo). Do pay attention to the quotes in that example.
.. _command-scheduler-remove:
scheduler remove <id>
^^^^^^^^^^^^^^^^^^^^^
Removes the event scheduled with id *<id>* from the schedule.
.. _plugin-scheduler-config:
Configuration
-------------
.. _supybot.plugins.Scheduler.public:
supybot.plugins.Scheduler.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

70
use/plugins/seeks.rst
View File

@ -1,70 +0,0 @@
.. _plugin-seeks:
The Seeks plugin
================
.. include:: unofficial.inc
Command
-------
.. _command-seeks-search:
seeks search <query>
^^^^^^^^^^^^^^^^^^^^
Searches the *<query>* in a seeks node.
.. _plugin-seeks-config:
Configuration
-------------
.. _supybot.plugins.Seeks.format:
supybot.plugins.Seeks.format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: %(url)s - %(seeks_score)s
The format used to display each result.
.. _supybot.plugins.Seeks.number:
supybot.plugins.Seeks.number
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 5
The number of results to display.
.. _supybot.plugins.Seeks.separator:
supybot.plugins.Seeks.separator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: /
The character(s) to use between search results.
.. _supybot.plugins.Seeks.url:
supybot.plugins.Seeks.url
^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: http://www.seeks.fr/search?expansion=1&action=expand&output=json&q=
The Seeks server that this plugin will use.
.. _supybot.plugins.Seeks.public:
supybot.plugins.Seeks.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

72
use/plugins/seen.rst
View File

@ -1,72 +0,0 @@
.. _plugin-seen:
The Seen plugin
===============
Commands
--------
.. _command-seen-user:
seen user [<channel>] <name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last time *<name>* was seen and what *<name>* was last seen
saying. This looks up *<name>* in the user seen database, which means
that it could be any nick recognized as user *<name>* that was seen.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-seen-seen:
seen seen [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last time *<nick>* was seen and what *<nick>* was last seen
saying. *<channel>* is only necessary if the message isn't sent on the
channel itself. *<nick>* may contain * as a wildcard.
.. _command-seen-any:
seen any [<channel>] [--user <name>] [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last time *<nick>* was seen and what *<nick>* was last seen
doing. This includes any form of activity, instead of just PRIVMSGs.
If *<nick>* isn't specified, returns the last activity seen in
*<channel>*. If *--user* is specified, looks up name in the user database
and returns the last time user was active in *<channel>*. *<channel>* is
only necessary if the message isn't sent on the channel itself.
.. _command-seen-last:
seen last [<channel>]
^^^^^^^^^^^^^^^^^^^^^
Returns the last thing said in *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-seen-since:
seen since [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the messages since *<nick>* last left the channel.
.. _plugin-seen-config:
Configuration
-------------
.. _supybot.plugins.Seen.public:
supybot.plugins.Seen.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

194
use/plugins/services.rst
View File

@ -1,194 +0,0 @@
.. _plugin-services:
The Services plugin
===================
NickServ
--------
.. _command-services-identify:
services identify
^^^^^^^^^^^^^^^^^
Identifies with NickServ using the current nick.
.. _command-services-nicks:
services nicks
^^^^^^^^^^^^^^
Returns the nicks that this plugin is configured to identify and ghost
with.
.. _command-services-password:
services password <nick> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the NickServ password for *<nick>* to *<password>*. If *<password>* is
not given, removes *<nick>* from the configured nicks.
.. _command-services-ghost:
services ghost [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^
Ghosts the bot's given nick and takes it. If no nick is given,
ghosts the bot's configured nick and takes it.
ChanServ
--------
.. _command-services-unban:
services unban [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Attempts to get unbanned by ChanServ in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself, but chances
are, if you need this command, you're not sending it in the channel
itself.
.. _command-services-invite:
services invite [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attempts to get invited by ChanServ to *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself, but chances
are, if you need this command, you're not sending it in the channel
itself.
.. _command-services-voice:
services voice [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Attempts to get voiced by ChanServ in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-services-op:
services op [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Attempts to get opped by ChanServ in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _plugin-services-config:
Configuration
-------------
.. _supybot.plugins.Services.ChanServ:
supybot.plugins.Services.ChanServ
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what nick the 'ChanServ' service has.
.. _supybot.plugins.Services.ChanServ.halfop:
supybot.plugins.Services.ChanServ.halfop
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will request to get half-opped by the ChanServ when it joins the channel.
.. _supybot.plugins.Services.ChanServ.op:
supybot.plugins.Services.ChanServ.op
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will request to get opped by the ChanServ when it joins the channel.
.. _supybot.plugins.Services.ChanServ.password:
supybot.plugins.Services.ChanServ.password
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what password the bot will use with ChanServ.
.. _supybot.plugins.Services.ChanServ.voice:
supybot.plugins.Services.ChanServ.voice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will request to get voiced by the ChanServ when it joins the channel.
.. _supybot.plugins.Services.NickServ:
supybot.plugins.Services.NickServ
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what nick the 'NickServ' service has.
.. _supybot.plugins.Services.NickServ.password:
supybot.plugins.Services.NickServ.password
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Services.disabledNetworks:
supybot.plugins.Services.disabledNetworks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: ['QuakeNet']
Determines what networks this plugin will be disabled on.
.. _supybot.plugins.Services.ghostDelay:
supybot.plugins.Services.ghostDelay
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 60
Determines how many seconds the bot will wait between successive GHOST attempts.
.. _supybot.plugins.Services.nicks:
supybot.plugins.Services.nicks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
Determines what nicks the bot will use with services.
.. _supybot.plugins.Services.noJoinsUntilIdentified:
supybot.plugins.Services.noJoinsUntilIdentified
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
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.
.. _supybot.plugins.Services.public:
supybot.plugins.Services.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

118
use/plugins/shrinkurl.rst
View File

@ -1,118 +0,0 @@
.. _plugin-shrinkurl:
The ShrinkUrl plugin
====================
Commands
--------
.. _command-shrinkurl-xrl:
shrinkurl xrl <url>
^^^^^^^^^^^^^^^^^^^
Returns an xrl.us version of *<url>*.
.. _command-shrinkurl-tiny:
shrinkurl tiny <url>
^^^^^^^^^^^^^^^^^^^^
Returns a TinyURL.com version of *<url>*
.. _command-shrinkurl-ln:
shrinkurl ln <url>
^^^^^^^^^^^^^^^^^^
Returns an ln-s.net version of *<url>*.
.. _plugin-shrinkurl-config:
Configuration
-------------
.. _supybot.plugins.ShrinkUrl.default:
supybot.plugins.ShrinkUrl.default
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: ln
Determines what website the bot will use when shrinking a URL.
.. _supybot.plugins.ShrinkUrl.minimumLength:
supybot.plugins.ShrinkUrl.minimumLength
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 48
The minimum length a URL must be before the bot will shrink it.
.. _supybot.plugins.ShrinkUrl.nonSnarfingRegexp:
supybot.plugins.ShrinkUrl.nonSnarfingRegexp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: None
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.
.. _supybot.plugins.ShrinkUrl.outFilter:
supybot.plugins.ShrinkUrl.outFilter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will shrink the URLs of outgoing messages if those URLs are longer than supybot.plugins.ShrinkUrl.minimumLength.
.. _supybot.plugins.ShrinkUrl.serviceRotation:
supybot.plugins.ShrinkUrl.serviceRotation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
If set to a non-empty value, specifies the list of services to rotate through for the shrinkSnarfer and outFilter.
.. _supybot.plugins.ShrinkUrl.shrinkSnarfer:
supybot.plugins.ShrinkUrl.shrinkSnarfer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
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 either ln-s.net or tinyurl.com, as denoted in supybot.plugins.ShrinkUrl.default.
.. _supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain:
supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the snarfer will show the domain of the URL being snarfed along with the shrunken URL.
.. _supybot.plugins.ShrinkUrl.bold:
supybot.plugins.ShrinkUrl.bold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin will bold certain portions of its replies.
.. _supybot.plugins.ShrinkUrl.public:
supybot.plugins.ShrinkUrl.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

117
use/plugins/status.rst
View File

@ -1,117 +0,0 @@
.. _plugin-status:
The Status plugin
=================
Commands
--------
.. _command-status-status:
status status
^^^^^^^^^^^^^
Returns the status of the bot.
.. _command-status-cmd:
status cmd
^^^^^^^^^^
Returns some interesting command-related statistics.
.. _command-status-commands:
status commands
^^^^^^^^^^^^^^^
Returns a list of the commands offered by the bot.
.. _command-status-uptime:
status uptime
^^^^^^^^^^^^^
Returns the amount of time the bot has been running.
.. _command-status-threads:
status threads
^^^^^^^^^^^^^^
Returns the current threads that are active.
.. _command-status-net:
status net
^^^^^^^^^^
Returns some interesting network-related statistics.
.. _command-status-server:
status server
^^^^^^^^^^^^^
Returns the server the bot is on.
.. _command-status-cpu:
status cpu
^^^^^^^^^^
Returns some interesting CPU-related statistics on the bot.
.. _plugin-status-config:
Configuration
-------------
.. _supybot.plugins.Status.cpu:
supybot.plugins.Status.cpu
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Status.cpu.children:
supybot.plugins.Status.cpu.children
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the cpu command will list the time taken by children as well as the bot's process.
.. _supybot.plugins.Status.cpu.memory:
supybot.plugins.Status.cpu.memory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the cpu command will report the amount of memory being used by the bot.
.. _supybot.plugins.Status.cpu.threads:
supybot.plugins.Status.cpu.threads
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the cpu command will provide the number of threads spawned and active.
.. _supybot.plugins.Status.public:
supybot.plugins.Status.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

151
use/plugins/string.rst
View File

@ -1,151 +0,0 @@
.. _plugin-string:
The String plugin
=================
Hashes
------
.. _command-string-soundex:
string soundex <string> [<length>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the Soundex hash to a given length. The length defaults to
4, since that's the standard length for a soundex hash. For unlimited
length, use 0.
.. _command-string-sha:
string sha <text>
^^^^^^^^^^^^^^^^^
Returns the SHA hash of a given string. Read
http://www.secure-hash-algorithm-md5-sha-1.co.uk/ for more information
about SHA.
Encoding/decoding
-----------------
.. _command-string-xor:
string xor <password> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* XOR-encrypted with *<password>*. See
http://www.yoe.org/developer/xor.html for information about XOR
encryption.
.. _command-string-encode:
string encode <encoding> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns an encoded form of the given text; the valid encodings are
available in the documentation of the Python codecs module:
*<http://docs.python.org/library/codecs.html#standard-encodings>*.
.. _command-string-decode:
string decode <encoding> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns an un-encoded form of the given text; the valid encodings are
available in the documentation of the Python codecs module:
*<http://docs.python.org/library/codecs.html#standard-encodings>*.
.. _command-string-ord:
string ord <letter>
^^^^^^^^^^^^^^^^^^^
Returns the 8-bit value of *<letter>*.
.. _command-string-chr:
string chr <number>
^^^^^^^^^^^^^^^^^^^
Returns the character associated with the 8-bit value *<number>*
Miscellaneous
-------------
.. _command-string-re:
string re <regexp> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^
If *<regexp>* is of the form m/regexp/flags, returns the portion of
*<text>* that matches the regexp. If *<regexp>* is of the form
s/regexp/replacement/flags, returns the result of applying such a
regexp to *<text>*.
.. _command-string-levenshtein:
string levenshtein <string1> <string2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the levenshtein distance (also known as the "edit distance"
between *<string1>* and *<string2>*)
.. _command-string-len:
string len <text>
^^^^^^^^^^^^^^^^^
Returns the length of *<text>*.
.. _plugin-string-config:
Configuration
-------------
.. _supybot.plugins.String.levenshtein:
supybot.plugins.String.levenshtein
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.String.levenshtein.max:
supybot.plugins.String.levenshtein.max
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 256
Determines the maximum size of a string given to the levenshtein command. The levenshtein command uses an O(m*n) algorithm, which means that with strings of length 256, it can take 1.5 seconds to finish; with strings of length 384, though, it can take 4 seconds to finish, and with strings of much larger lengths, it takes more and more time. Using nested commands, strings can get quite large, hence this variable, to limit the size of arguments passed to the levenshtein command.
.. _supybot.plugins.String.re:
supybot.plugins.String.re
^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.String.re.timeout:
supybot.plugins.String.re.timeout
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 0.1
Determines the maximum time, in seconds, that a regular expression is given to execute before being terminated. Since there is a possibility that user input for the re command can cause it to eat up large amounts of ram or cpu time, it's a good idea to keep this low. Most normal regexps should not take very long at all.
.. _supybot.plugins.String.public:
supybot.plugins.String.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

31
use/plugins/success.rst
View File

@ -1,31 +0,0 @@
.. _plugin-success:
The Success plugin
==================
.. _plugin-success-config:
Configuration
-------------
.. _supybot.plugins.Success.prefixNick:
supybot.plugins.Success.prefixNick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will prefix the nick of the user giving an invalid command to the success response.
.. _supybot.plugins.Success.public:
supybot.plugins.Success.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

63
use/plugins/sudo.rst
View File

@ -1,63 +0,0 @@
.. _plugin-sudo:
The Sudo plugin
===============
.. include:: unofficial.inc
Commands
--------
.. _command-sudo-sudo:
sudo sudo <commande> [<arg1> [<arg2> ...]]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Runs the command following the Sudo rules.
.. _command-sudo-remove:
sudo remove <id>
^^^^^^^^^^^^^^^^
Remove a Sudo rule.
.. _command-sudo-fakehostmask:
sudo fakehostmask <hostmask> <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Runs *<command>* as if you were wearing the *<hostmask>*. Of course, usage
of the command is restricted to the owner.
.. _command-sudo-add:
sudo add [<priority>] <name> {allow,deny} [<hostmask>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets a new Sudo rule, called *<name>* with the given *<priority>*
(greatest numbers have precedence),
allowing or denying to run commands matching the pattern *<regexp>*,
from users to run commands as wearing the *<hostmask>*.
The *<priority>* must be a relative integer.
If *<priority>* is not given, it defaults to 0.
The *<hostmask>* defaults to your hostmask.
The *<hostmask>* is only needed if you set an 'allow' rule.
.. _plugin-sudo-config:
Configuration
-------------
.. _supybot.plugins.Sudo.public:
supybot.plugins.Sudo.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

43
use/plugins/supyml.rst
View File

@ -1,43 +0,0 @@
.. _plugin-supyml:
The SupyML plugin
=================
.. include:: unofficial.inc
Command
-------
.. _command-supyml-eval:
supyml eval [--warnings] <SupyML script>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Executes the *<SupyML script>*
.. _plugin-supyml-config:
Configuration
-------------
.. _supybot.plugins.SupyML.maxnodes:
supybot.plugins.SupyML.maxnodes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 30
Determines the maximum number of nodes processed by the 'SupyML eval' command.
.. _supybot.plugins.SupyML.public:
supybot.plugins.SupyML.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

33
use/plugins/supysandbox.rst
View File

@ -1,33 +0,0 @@
.. _plugin-supysandbox:
The SupySandbox plugin
======================
.. include:: unofficial.inc
Command
-------
.. _command-supysandbox-sandbox:
supysandbox sandbox <code>
^^^^^^^^^^^^^^^^^^^^^^^^^^
Runs Python code safely thanks to pysandbox
.. _plugin-supysandbox-config:
Configuration
-------------
.. _supybot.plugins.SupySandbox.public:
supybot.plugins.SupySandbox.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

96
use/plugins/time.rst
View File

@ -1,96 +0,0 @@
.. _plugin-time:
The Time plugin
===============
Relative time
-------------
.. _command-time-ctime:
time ctime [<seconds since epoch>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the ctime for *<seconds since epoch>*, or the current ctime if
no *<seconds since epoch>* is given.
.. _command-time-time:
time time [<format>] [<seconds since epoch>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current time in *<format>* format, or, if *<format>* is not
given, uses the configurable format for the current channel. If no
*<seconds since epoch>* time is given, the current time is used.
.. _command-time-elapsed:
time elapsed <seconds>
^^^^^^^^^^^^^^^^^^^^^^
Returns a pretty string that is the amount of time represented by
*<seconds>*.
time until <time string>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns the number of seconds until *<time string>*.
Absolute time
-------------
.. _command-time-seconds:
time seconds [<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the number of seconds in the number of *<years>*, *<weeks>*,
*<days>*, *<hours>*, *<minutes>*, and *<seconds>* given. An example usage is
"seconds 2h 30m", which would return 9000, which is '3600*2 + 30*60'.
Useful for scheduling events at a given number of seconds in the
future.
.. _command-time-at:
time at <time string>
^^^^^^^^^^^^^^^^^^^^^
Returns the number of seconds since epoch *<time string>* is.
*<time string>* can be any number of natural formats; just try something
and see if it will work.
.. _command-time-tztime:
time tztime <region>/<city>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Takes a city and its region, and returns the locale time.
.. _command-time-until:
.. _plugin-time-config:
Configuration
-------------
.. _supybot.plugins.Time.format:
supybot.plugins.Time.format
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: %I:%M %p, %B %d, %Y
Determines the format string for timestamps. Refer to the Python documentation for the time module to see what formats are accepted. If you set this variable to the empty string, the timestamp will not be shown.
.. _supybot.plugins.Time.public:
supybot.plugins.Time.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

48
use/plugins/timebomb.rst
View File

@ -1,48 +0,0 @@
.. _plugin-timebomb:
The Timebomb plugin
===================
The timebomb game.
.. include:: unofficial.inc
Commands
--------
.. _command-timebomb-cutwire:
timebomb cutwire <colored wire>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Will cut the given wire if you've been timebombed.
.. _command-timebomb-randombomb:
timebomb randombomb
^^^^^^^^^^^^^^^^^^^
Bombs a random person in the channel
.. _command-timebomb-detonate:
timebomb detonate Takes no arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Detonates the active bomb.
.. _command-timebomb-duck:
timebomb duck
^^^^^^^^^^^^^
DUCK!
.. _command-timebomb-timebomb:
timebomb timebomb <nick>
^^^^^^^^^^^^^^^^^^^^^^^^
For bombing people!

85
use/plugins/todo.rst
View File

@ -1,85 +0,0 @@
.. _plugin-todo:
The Todo plugin
===============
Reading
-------
.. _command-todo-todo:
todo todo [<username>] [<task id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Retrieves a task for the given task id. If no task id is given, it
will return a list of task ids that that user has added to their todo
list.
.. _command-todo-search:
todo search [--{regexp} <value>] [<glob> <glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches your todos for tasks matching *<glob>*. If *--regexp* is given,
its associated value is taken as a regexp and matched against the
tasks.
Editing
-------
.. _command-todo-add:
todo add [--priority=<num>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<text>* as a task in your own personal todo list. The optional
priority argument allows you to set a task as a high or low priority.
Any integer is valid.
.. _command-todo-remove:
todo remove <task id> [<task id> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes *<task id>* from your personal todo list.
.. _command-todo-setpriority:
todo setpriority <id> <priority>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the priority of the todo with the given id to the specified value.
.. _command-todo-change:
todo change <task id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Modify the task with the given id using the supplied regexp.
.. _plugin-todo-config:
Configuration
-------------
.. _supybot.plugins.Todo.allowThirdpartyReader:
supybot.plugins.Todo.allowThirdpartyReader
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether users can read the todo-list of another user.
.. _supybot.plugins.Todo.public:
supybot.plugins.Todo.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

274
use/plugins/topic.rst
View File

@ -1,274 +0,0 @@
.. _plugin-topic:
The Topic plugin
================
Getting
-------
.. _command-topic-topic:
topic topic [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Returns the topic for *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-topic-get:
topic get [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns topic number *<number>* from *<channel>*. *<number>* is a one-based
index into the topics. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-topic-list:
topic list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Returns a list of the topics in *<channel>*, prefixed by their indexes.
Mostly useful for topic reordering. *<channel>* is only necessary if the
message isn't sent in the channel itself.
Defining
--------
.. _command-topic-restore:
topic restore [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
Restores the topic to the last topic set by the bot. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-topic-set:
topic set [<channel>] [<number>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the topic *<number>* to be *<text>*. If no *<number>* is given, this
sets the entire topic. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-topic-replace:
topic replace [<channel>] <number> <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replaces topic *<number>* with *<topic>*.
.. _command-topic-fit:
topic fit [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<topic>* to the topics for *<channel>*. If the topic is too long
for the server, topics will be popped until there is enough room.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-topic-add:
topic add [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<topic>* to the topics for *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-topic-remove:
topic remove [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes topic *<number>* from the topic for *<channel>* Topics are
numbered starting from 1; you can also use negative indexes to refer
to topics starting the from the end of the topic. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-topic-change:
topic change [<channel>] <number> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes the topic number *<number>* on *<channel>* according to the regular
expression *<regexp>*. *<number>* is the one-based index into the topics;
*<regexp>* is a regular expression of the form
s/regexp/replacement/flags. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-topic-insert:
topic insert [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<topic>* to the topics for *<channel>* at the beginning of the topics
currently on *<channel>*. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-topic-default:
topic default [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the topic in *<channel>* to the default topic for *<channel>*. The
default topic for a channel may be configured via the configuration
variable :ref:`supybot.plugins.Topic.default.`
Re-ordering
-----------
.. _command-topic-shuffle:
topic shuffle [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
Shuffles the topics in *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-topic-reorder:
topic reorder [<channel>] <number> [<number> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Reorders the topics from *<channel>* in the order of the specified
*<number>* arguments. *<number>* is a one-based index into the topics.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-topic-swap:
topic swap [<channel>] <first topic number> <second topic number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Swaps the order of the first topic number and the second topic number.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
Locking
-------
.. _command-topic-lock:
topic lock [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Locks the topic (sets the mode +t) in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-topic-unlock:
topic unlock [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the topic (sets the mode +t) in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
Utilities
---------
.. _command-topic-undo:
topic undo [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Restores the topic to the one previous to the last topic command that
set it. *<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-topic-redo:
topic redo [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Undoes the last undo. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-topic-separator:
topic separator [<channel>] <separator>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the topic separator for *<channel>* to *<separator>* Converts the
current topic appropriately.
.. _plugin-topic-config:
Configuration
-------------
.. _supybot.plugins.Topic.default:
supybot.plugins.Topic.default
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what the default topic for the channel is. This is used by the default command to set this topic.
.. _supybot.plugins.Topic.format:
supybot.plugins.Topic.format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: $topic ($nick)
Determines what format is used to add topics in the topic. All the standard substitutes apply, in addition to "$topic" for the topic itself.
.. _supybot.plugins.Topic.recognizeTopiclen:
supybot.plugins.Topic.recognizeTopiclen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will recognize the TOPICLEN value sent to it by the server and thus refuse to send TOPICs longer than the TOPICLEN. These topics are likely to be truncated by the server anyway, so this defaults to True.
.. _supybot.plugins.Topic.requireManageCapability:
supybot.plugins.Topic.requireManageCapability
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: channel,op; channel,halfop
Determines the capabilities required (if any) to make any topic changes, (everything except for read-only operations). Use 'channel,capab' for channel-level capabilities. Note that absence of an explicit anticapability means user has capability.
.. _supybot.plugins.Topic.separator:
supybot.plugins.Topic.separator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: ||
Determines what separator is used between individually added topics in the channel topic.
.. _supybot.plugins.Topic.undo:
supybot.plugins.Topic.undo
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Topic.undo.max:
supybot.plugins.Topic.undo.max
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 10
Determines the number of previous topics to keep around in case the undo command is called.
.. _supybot.plugins.Topic.public:
supybot.plugins.Topic.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

78
use/plugins/trigger.rst
View File

@ -1,78 +0,0 @@
.. _plugin-trigger:
The Trigger plugin
==================
.. include:: unofficial.inc
.. _plugin-trigger-config:
Configuration
-------------
.. _supybot.plugins.Trigger.triggers:
supybot.plugins.Trigger.triggers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Trigger.triggers.join:
supybot.plugins.Trigger.triggers.join
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered by %s
.. _supybot.plugins.Trigger.triggers.notice:
supybot.plugins.Trigger.triggers.notice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered by %s
.. _supybot.plugins.Trigger.triggers.part:
supybot.plugins.Trigger.triggers.part
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered by %s
.. _supybot.plugins.Trigger.triggers.privmsg:
supybot.plugins.Trigger.triggers.privmsg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered by %s
.. _supybot.plugins.Trigger.triggers.connect:
supybot.plugins.Trigger.triggers.connect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered on connect. This shouldn't be a Supybot command, but an IRC command (as given to ircquote).
.. _supybot.plugins.Trigger.public:
supybot.plugins.Trigger.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

27
use/plugins/trivia.rst
View File

@ -1,27 +0,0 @@
.. _plugin-trivia:
The Trivia plugin
=================
The trivia game.
.. include:: unofficial.inc
Command
-------
.. _command-trivia-strivia:
trivia strivia [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Stops a running game of trivia. *<channel>* is only necessary if the message isn't sent in the channel itself.
.. _command-trivia-trivia:
trivia trivia [<channel>] [<number of questions>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Starts a game of trivia. *<channel>* is only necessary if the message isn't sent in the channel itself.

185
use/plugins/twitter.rst
View File

@ -1,185 +0,0 @@
.. _plugin-twitter:
The Twitter plugin
==================
.. include:: unofficial.inc
Tweets
--------
.. _command-twitter-timeline:
twitter timeline [<channel>] [<user>] [--since <oldest>] [--max <newest>] [--count <number>] [--noretweet] [--with-id]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with the timeline of the *<user>*.
If *<user>* is not given, it defaults to the account associated with the
*<channel>*.
If *<channel>* is not given, it defaults to the current channel.
If given, *--since* and *--max* take tweet IDs, used as boundaries.
If given, *--count* takes an integer, that stands for the number of
tweets to display.
If *--noretweet* is given, only native user's tweet will be displayed.
.. _command-twitter-replies:
twitter replies [<channel>] [--since <oldest>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with the replies timeline.
If *<channel>* is not given, it defaults to the current channel.
If given, *--since* takes a tweet ID, used as a boundary
.. _command-twitter-post:
twitter post [<channel>] <message>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Updates the status of the account associated with the given *<channel>*
to the *<message>*. If *<channel>* is not given, it defaults to the
current channel.
.. _command-twitter-public:
twitter public [<channel>] [--since <oldest>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with the public timeline.
If *<channel>* is not given, it defaults to the current channel.
If given, *--since* takes a tweet ID, used as a boundary
.. _command-twitter-delete:
twitter delete [<channel>] <id>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Delete a specified status with id *<id>*
If *<channel>* is not given, it defaults to the current channel.
Friends
-------
.. _command-twitter-friendslist:
twitter friendslist [<channel>] [<user>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with the friends (i.e. people who one subscribes to) of the
*<user>*. If *<user>* is not given, it defaults to the *<channel>*'s account.
If *<channel>* is not given, it defaults to the current channel.
.. _command-twitter-unfollow:
twitter unfollow [<channel>] <user>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unfollow a specified *<user>*
If *<channel>* is not given, it defaults to the current channel.
.. _command-twitter-follow:
twitter follow [<channel>] <user>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Follow a specified *<user>*
If *<channel>* is not given, it defaults to the current channel.
.. _plugin-twitter-config:
Configuration
-------------
.. _supybot.plugins.Twitter.accounts:
supybot.plugins.Twitter.accounts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Twitter.accounts.bot:
supybot.plugins.Twitter.accounts.bot
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Twitter.accounts.bot.api:
supybot.plugins.Twitter.accounts.bot.api
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: https://api.twitter.com/1
The URL to the base API URL (by default, it is Twitter.com, but you can use it for twitter-compatible services, such as identica/statusnet.
.. _supybot.plugins.Twitter.accounts.bot.key:
supybot.plugins.Twitter.accounts.bot.key
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
The Twitter Access Token key for the bot's account (running get_access_token.py is a way to get it)
.. _supybot.plugins.Twitter.accounts.bot.secret:
supybot.plugins.Twitter.accounts.bot.secret
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
The Twitter Access Token secret for the bot's account (running get_access_token.py is a way to get it)
.. _supybot.plugins.Twitter.accounts.channel:
supybot.plugins.Twitter.accounts.channel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Twitter.accounts.channel.key:
supybot.plugins.Twitter.accounts.channel.key
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
The Twitter Access Token key for this channel's account (running get_access_token.py is a way to get it)
.. _supybot.plugins.Twitter.accounts.channel.secret:
supybot.plugins.Twitter.accounts.channel.secret
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
The Twitter Access Token secret for this channel's account (running get_access_token.py is a way to get it)
.. _supybot.plugins.Twitter.accounts.channel.api:
supybot.plugins.Twitter.accounts.channel.api
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: https://api.twitter.com/1
The URL to the base API URL (by default, it is Twitter.com, but you can use it for twitter-compatible services, such as identica/statusnet.
.. _supybot.plugins.Twitter.public:
supybot.plugins.Twitter.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

212
use/plugins/unix.rst
View File

@ -1,212 +0,0 @@
.. _plugin-unix:
The Unix plugin
===============
Utitilies
---------
.. _command-unix-errno:
unix errno <error number or code>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the number of an errno code, or the errno code of a number.
.. _command-unix-spell:
unix spell <word>
^^^^^^^^^^^^^^^^^
Returns the result of passing *<word>* to aspell/ispell. The results
shown are sorted from best to worst in terms of being a likely match
for the spelling of *<word>*.
.. _command-unix-pid:
unix pid
^^^^^^^^
Returns the current pid of the process for this Supybot.
.. _command-unix-call:
unix call <command to call with any arguments>
Calls any command available on the system, and returns its output.
Requires owner capability.
Note that being restricted to owner, this command does not do any
sanity checking on input/output. So it is up to you to make sure
you don't run anything that will spamify your channel or that
will bring your machine to its knees.
.. _command-unix-crypt:
unix crypt <password> [<salt>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the resulting of doing a crypt() on *<password>* If *<salt>* is
not given, uses a random salt. If running on a glibc2 system,
prepending '$1$' to your salt will cause crypt to return an MD5sum
based crypt rather than the standard DES based crypt.
.. _command-unix-progstats:
unix progstats
^^^^^^^^^^^^^^
Returns various unix-y information on the running supybot process.
.. _command-unix-ping:
unix ping [--c <count>] [--i <interval>] [--t <ttl>] [--W <timeout>] <host or ip>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sends an ICMP echo request to the specified host.
The arguments correspond with those listed in ping(8). --c is
limited to 10 packets or less (default is 5). --i is limited to 5
or less. --W is limited to 10 or less.
Fun
---
.. _command-unix-fortune:
unix fortune
^^^^^^^^^^^^
Returns a fortune from the \*nix fortune program.
.. _command-unix-wtf:
unix wtf [is] <something>
^^^^^^^^^^^^^^^^^^^^^^^^^
Returns wtf *<something>* is. 'wtf' is a \*nix command that first
appeared in NetBSD 1.5. In most \*nices, it's available in some sort
of 'bsdgames' package.
.. _plugin-unix-config:
Configuration
-------------
.. _supybot.plugins.Unix.fortune:
supybot.plugins.Unix.fortune
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Unix.fortune.command:
supybot.plugins.Unix.fortune.command
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what command will be called for the fortune command.
.. _supybot.plugins.Unix.fortune.equal:
supybot.plugins.Unix.fortune.equal
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether fortune will give equal weight to the different fortune databases. If false, then larger databases will be given more weight. This sends the -e option to the fortune program.
.. _supybot.plugins.Unix.fortune.files:
supybot.plugins.Unix.fortune.files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: []
Determines what specific file (if any) will be used with the fortune command; if none is given, the system-wide default will be used. Do note that this fortune file must be placed with the rest of your system's fortune files.
.. _supybot.plugins.Unix.fortune.offensive:
supybot.plugins.Unix.fortune.offensive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether fortune will retrieve offensive fortunes along with the normal fortunes. This sends the -a option to the fortune program.
.. _supybot.plugins.Unix.fortune.short:
supybot.plugins.Unix.fortune.short
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether only short fortunes will be used if possible. This sends the -s option to the fortune program.
.. _supybot.plugins.Unix.ping:
supybot.plugins.Unix.ping
^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Unix.ping.command:
supybot.plugins.Unix.ping.command
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: /bin/ping
Determines what command will be called for the ping command.
.. _supybot.plugins.Unix.spell:
supybot.plugins.Unix.spell
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Unix.spell.command:
supybot.plugins.Unix.spell.command
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: /usr/bin/aspell
Determines what command will be called for the spell command.
.. _supybot.plugins.Unix.wtf:
supybot.plugins.Unix.wtf
^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Unix.wtf.command:
supybot.plugins.Unix.wtf.command
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Determines what command will be called for the wtf command.
.. _supybot.plugins.Unix.public:
supybot.plugins.Unix.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

8
use/plugins/unofficial.inc
View File

@ -1,8 +0,0 @@
fooo
.. note::
This plugin is not provided with Limnoria. You need to download it yourself,
either from a repository or with
:ref:`PluginDownloader <plugin-plugindownloader>`.

55
use/plugins/url.rst
View File

@ -1,55 +0,0 @@
.. _plugin-url:
The URL plugin
==============
Commands
--------
.. _command-url-stats:
url stats [<channel>]
^^^^^^^^^^^^^^^^^^^^^
Returns the number of URLs in the URL database. *<channel>* is only
required if the message isn't sent in the channel itself.
.. _command-url-last:
url last [<channel>] [--{from,with,without,near,proto} <value>] [--nolimit]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the last URL matching the given criteria. *--from* is from whom
the URL came; *--proto* is the protocol the URL used; *--with* is something
inside the URL; *--without* is something that should not be in the URL;
*--near* is something in the same message as the URL; If *--nolimit* is
given, returns all the URLs that are found. to just the URL.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _plugin-url-config:
Configuration
-------------
.. _supybot.plugins.URL.nonSnarfingRegexp:
supybot.plugins.URL.nonSnarfingRegexp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: None
Determines what URLs are not to be snarfed and stored in the database for the channel; URLs matching the given regexp will not be snarfed. Give the empty string if you have no URLs that you'd like to exclude from being snarfed.
.. _supybot.plugins.URL.public:
supybot.plugins.URL.public
^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

184
use/plugins/user.rst
View File

@ -1,184 +0,0 @@
.. _plugin-user:
The User plugin
===============
Registration and hostmasks
--------------------------
.. _command-user-username:
user username <hostmask|nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the username of the user specified by *<hostmask>* or *<nick>* if
the user is registered.
.. _command-user-set-password:
user set password [<name>] <old password> <new password>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the new password for the user specified by *<name>* to *<new
password>*. Obviously this message must be sent to the bot
privately (not in a channel). If the requesting user is an owner
user (and the user whose password is being changed isn't that same
owner user), then *<old password>* needn't be correct.
.. _command-user-set-secure:
user set secure <password> [<True|False>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the secure flag on the user of the person sending the message.
Requires that the person's hostmask be in the list of hostmasks for
that user in addition to the password being correct. When the
secure flag is set, the user *must* identify before he can be
recognized. If a specific True/False value is not given, it
inverts the current value.
.. _command-user-hostmask-hostmask:
user hostmask hostmask [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the hostmask of *<nick>*. If *<nick>* isn't given, return the
hostmask of the person giving the command.
.. _command-user-hostmask-list:
user hostmask list [<name>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the hostmasks of the user specified by *<name>*; if *<name>*
isn't specified, returns the hostmasks of the user calling the
command.
.. _command-user-hostmask-add:
user hostmask add [<name>] [<hostmask>] [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds the hostmask *<hostmask>* to the user specified by *<name>*. The
*<password>* may only be required if the user is not recognized by
hostmask. *<password>* is also not required if an owner user is
giving the command on behalf of some other user. If *<hostmask>* is
not given, it defaults to your current hostmask. If *<name>* is not
given, it defaults to your currently identified name. This message
must be sent to the bot privately (not on a channel) since it may
contain a password.
.. _command-user-hostmask-remove:
user hostmask remove <name> <hostmask> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the hostmask *<hostmask>* from the record of the user
specified by *<name>*. If the hostmask given is 'all' then all
hostmasks will be removed. The *<password>* may only be required if
the user is not recognized by his hostmask. This message must be
sent to the bot privately (not on a channel) since it may contain a
password.
.. _command-user-unregister:
user unregister <name> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unregisters *<name>* from the user database. If the user giving this
command is an owner user, the password is not necessary.
.. _command-user-register:
user register <name> <password>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Registers *<name>* with the given password *<password>* and the current
hostmask of the person registering. You shouldn't register twice; if
you're not recognized as a user but you've already registered, use the
hostmask add command to add another hostmask to your already-registered
user, or use the identify command to identify just for a session.
This command (and all other commands that include a password) must be
sent to the bot privately, not in a channel.
.. _command-user-unidentify:
user unidentify
^^^^^^^^^^^^^^^
Un-identifies you. Note that this may not result in the desired
effect of causing the bot not to recognize you anymore, since you may
have added hostmasks to your user that can cause the bot to continue to
recognize you.
.. _command-user-identify:
user identify <name> <password>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Identifies the user as *<name>*. This command (and all other
commands that include a password) must be sent to the bot privately,
not in a channel.
.. _command-user-changename:
user changename <name> <new name> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes your current user database name to the new name given.
*<password>* is only necessary if the user isn't recognized by hostmask.
This message must be sent to the bot privately (not on a channel) since
it may contain a password.
Capabilities
------------
.. _command-user-capabilities:
user capabilities [<name>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the capabilities of the user specified by *<name>*; if *<name>*
isn't specified, returns the capabilities of the user calling the
command.
Other commands
.. _command-user-stats:
user stats
^^^^^^^^^^
Returns some statistics on the user database.
.. _command-user-list:
user list [--capability=<capability>] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the valid registered usernames matching *<glob>*. If *<glob>* is
not given, returns all registered usernames.
.. _command-user-whoami:
user whoami
^^^^^^^^^^^
Returns the name of the user calling the command.
.. _plugin-user-config:
Configuration
-------------
.. _supybot.plugins.User.public:
supybot.plugins.User.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

94
use/plugins/utilities.rst
View File

@ -1,94 +0,0 @@
.. _plugin-utilities:
The Utilities plugin
====================
Random
------
.. _command-utilities-shuffle:
utilities shuffle <arg> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Shuffles the arguments given.
.. _command-utilities-sample:
utilities sample <num> <arg> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Randomly chooses *<num>* items out of the arguments given.
Programming/nesting
-------------------
.. _command-utilities-ignore:
utilities ignore requires no arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Does nothing. Useful sometimes for sequencing commands when you don't
care about their non-error return values.
.. _command-utilities-success:
utilities success [<text>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Does nothing except to reply with a success message. This is useful
when you want to run multiple commands as nested commands, and don't
care about their output as long as they're successful. An error, of
course, will break out of this command. *<text>*, if given, will be
appended to the end of the success message.
.. _command-utilities-echo:
utilities echo <text>
^^^^^^^^^^^^^^^^^^^^^
Returns the arguments given it. Uses our standard substitute on the
string(s) given to it; $nick (or $who), $randomNick, $randomInt,
$botnick, $channel, $user, $host, $today, $now, and $randomDate are all
handled appropriately.
.. _command-utilities-countargs:
utilities countargs <arg> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Counts the arguments given.
.. _command-utilities-apply:
utilities apply <command> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Tokenizes *<text>* and calls *<command>* with the resulting arguments.
.. _command-utilities-last:
utilities last <text> [<text> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last argument given. Useful when you'd like multiple
nested commands to run, but only the output of the last one to be
returned.
.. _plugin-utilities-config:
Configuration
-------------
.. _supybot.plugins.Utilities.public:
supybot.plugins.Utilities.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

129
use/plugins/web.rst
View File

@ -1,129 +0,0 @@
.. _plugin-web:
The Web plugin
==============
HTTP
----
.. _command-web-urlunquote:
web urlunquote <text>
^^^^^^^^^^^^^^^^^^^^^
Returns the text un-URL quoted.
.. _command-web-urlquote:
web urlquote <text>
^^^^^^^^^^^^^^^^^^^
Returns the URL quoted form of the text.
.. _command-web-size:
web size <url>
^^^^^^^^^^^^^^
Returns the Content-Length header of *<url>*. Only HTTP urls are valid,
of course.
HTML
----
.. _command-web-title:
web title <url>
^^^^^^^^^^^^^^^
Returns the HTML *<title>*...*</title>* of a URL.
.. _command-web-doctype:
web doctype <url>
^^^^^^^^^^^^^^^^^
Returns the DOCTYPE string of *<url>*. Only HTTP urls are valid, of
course.
.. _command-web-headers:
web headers <url>
^^^^^^^^^^^^^^^^^
Returns the HTTP headers of *<url>*. Only HTTP urls are valid, of
course.
Others
------
.. _command-web-netcraft:
web netcraft <hostname|ip>
^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns Netcraft.com's determination of what operating system and
webserver is running on the host given.
.. _command-web-fetch:
web fetch <url>
^^^^^^^^^^^^^^^
Returns the contents of *<url>*, or as much as is configured in
:ref:`supybot.plugins.Web.fetch.maximum.` If that configuration variable is
set to 0, this command will be effectively disabled.
.. _plugin-web-config:
Configuration
-------------
.. _supybot.plugins.Web.nonSnarfingRegexp:
supybot.plugins.Web.nonSnarfingRegexp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: None
Determines what URLs are to be snarfed and stored in the database in the channel; 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.
.. _supybot.plugins.Web.titleSnarfer:
supybot.plugins.Web.titleSnarfer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will output the HTML title of URLs it sees in the channel.
.. _supybot.plugins.Web.fetch:
supybot.plugins.Web.fetch
^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Web.fetch.maximum:
supybot.plugins.Web.fetch.maximum
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 0
Determines the maximum number of bytes the bot will download via the 'fetch' command in this plugin.
.. _supybot.plugins.Web.public:
supybot.plugins.Web.public
^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

51
use/plugins/webstats.rst
View File

@ -1,51 +0,0 @@
.. _plugin-webstats:
The WebStats plugin
===================
.. include:: unofficial.inc
.. _plugin-webstats-config:
Configuration
-------------
.. _supybot.plugins.WebStats.channel:
supybot.plugins.WebStats.channel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.WebStats.channel.enable:
supybot.plugins.WebStats.channel.enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the stats are enabled for this channel.
.. _supybot.plugins.WebStats.channel.language:
supybot.plugins.WebStats.channel.language
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: en
Determines what language is used on the website
.. _supybot.plugins.WebStats.public:
supybot.plugins.WebStats.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

40
use/plugins/wikipedia.rst
View File

@ -1,40 +0,0 @@
.. _plugin-wikipedia:
The Wikipedia plugin
====================
.. include:: unofficial.inc
.. _command-wikipedia-wiki:
wikipedia wiki <search term>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the first paragraph of a Wikipedia article
.. _plugin-wikipedia-config:
Configuration
-------------
.. _supybot.plugins.Wikipedia.url:
supybot.plugins.Wikipedia.url
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: en.wikipedia.org
URL of the website from where you want to pull pages (usually: your language's wikipedia)
.. _supybot.plugins.Wikipedia.public:
supybot.plugins.Wikipedia.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

35
use/plugins/wikitrans.rst
View File

@ -1,35 +0,0 @@
.. _plugin-wikitrans:
The WikiTrans plugin
====================
.. include:: unofficial.inc
Command
-------
.. _command-wikitrans-translate:
wikitrans translate <from language> <to language> <word>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Translates the *<word>* (also works with expressions) using Wikipedia
interlanguage links.
.. _plugin-wikitrans-config:
Configuration
-------------
.. _supybot.plugins.WikiTrans.public:
supybot.plugins.WikiTrans.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.