Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-22 20:19:32 +01:00
Code Issues Projects Releases Wiki Activity

Fix plugin docs.

Browse Source
This commit is contained in:
Valentin Lorentz 2011-06-28 08:13:53 +02:00
parent 506278f454
commit 2ce465adcd
55 changed files with 409 additions and 409 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
generate_plugin_doc.py
View File

@ -52,7 +52,7 @@ def writeDoc(PluginClass, fd, prefix):
}
args['decoration'] = '^'*len('%(prefix_with_trailing_space)s%(command)s%(syntax)s' %
args)
fd.write('.. command-%(prefix_dash)s%(command)s:\n\n'
fd.write('.. _command-%(prefix_dash)s%(command)s:\n\n'
'%(prefix_with_trailing_space)s%(command)s%(syntax)s\n'
'%(decoration)s\n\n'
'%(help_string)s\n\n' % args)

18
use/plugins/admin.rst
View File

@ -4,7 +4,7 @@
The Admin plugin
================
.. command-channels:
.. _command-channels:
channels
^^^^^^^^
@ -13,7 +13,7 @@ Returns the channels the bot is on. Must be given in private, in order
to protect the secrecy of secret channels.
.. command-part:
.. _command-part:
part [<channel>] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -24,7 +24,7 @@ current channel. If *<reason>* is specified, use it as the part
message.
.. command-ignore-list:
.. _command-ignore-list:
ignore list
^^^^^^^^^^^
@ -32,7 +32,7 @@ ignore list
Lists the hostmasks that the bot is ignoring.
.. command-ignore-remove:
.. _command-ignore-remove:
ignore remove <hostmask|nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -41,7 +41,7 @@ This will remove the persistent ignore on *<hostmask>* or the
hostmask currently associated with *<nick>*.
.. command-ignore-add:
.. _command-ignore-add:
ignore add <hostmask|nick> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -52,7 +52,7 @@ specifying when (in "seconds from now") the ignore will expire; if
it isn't given, the ignore will never automatically expire.
.. command-join:
.. _command-join:
join <channel> [<key>]
^^^^^^^^^^^^^^^^^^^^^^
@ -61,7 +61,7 @@ Tell the bot to join the given channel. If *<key>* is given, it is used
when attempting to join the channel.
.. command-capability-add:
.. _command-capability-add:
capability add <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -70,7 +70,7 @@ Gives the user specified by *<name>* (or the user to whom *<hostmask>*
currently maps) the specified capability *<capability>*
.. command-capability-remove:
.. _command-capability-remove:
capability remove <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -79,7 +79,7 @@ Takes from the user specified by *<name>* (or the user to whom
*<hostmask>* currently maps) the specified capability *<capability>*
.. command-nick:
.. _command-nick:
nick [<nick>]
^^^^^^^^^^^^^

8
use/plugins/alias.rst
View File

@ -4,7 +4,7 @@
The Alias plugin
================
.. command-lock:
.. _command-lock:
lock <alias>
^^^^^^^^^^^^
@ -12,7 +12,7 @@ lock <alias>
Locks an alias so that no one else can change it.
.. command-unlock:
.. _command-unlock:
unlock <alias>
^^^^^^^^^^^^^^
@ -20,7 +20,7 @@ unlock <alias>
Unlocks an alias so that people can define new aliases over it.
.. command-remove:
.. _command-remove:
remove <name>
^^^^^^^^^^^^^
@ -28,7 +28,7 @@ remove <name>
Removes the given alias, if unlocked.
.. command-add:
.. _command-add:
add <name> <alias>
^^^^^^^^^^^^^^^^^^

4
use/plugins/anonymous.rst
View File

@ -4,7 +4,7 @@
The Anonymous plugin
====================
.. command-do:
.. _command-do:
do <channel> <action>
^^^^^^^^^^^^^^^^^^^^^
@ -12,7 +12,7 @@ do <channel> <action>
Performs *<action>* in *<channel>*.
.. command-say:
.. _command-say:
say <channel|nick> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^

8
use/plugins/badwords.rst
View File

@ -4,14 +4,14 @@
The BadWords plugin
===================
.. command-sub:
.. _command-sub:
sub
^^^^
.. command-list:
.. _command-list:
list
^^^^
@ -19,7 +19,7 @@ list
Returns the list of words being censored.
.. command-remove:
.. _command-remove:
remove <word> [<word> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -27,7 +27,7 @@ remove <word> [<word> ...]
Removes *<word>*s from the list of words being censored.
.. command-add:
.. _command-add:
add <word> [<word> ...]
^^^^^^^^^^^^^^^^^^^^^^^

70
use/plugins/channel.rst
View File

@ -4,7 +4,7 @@
The Channel plugin
==================
.. command-unmoderate:
.. _command-unmoderate:
unmoderate [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ send messages to the channel. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-devoice:
.. _command-devoice:
devoice [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -24,7 +24,7 @@ the nicks given. If no nicks are given, removes voice from the person
sending the message.
.. command-lobotomy-list:
.. _command-lobotomy-list:
lobotomy list
^^^^^^^^^^^^^
@ -32,7 +32,7 @@ lobotomy list
Returns the channels in which this bot is lobotomized.
.. command-lobotomy-remove:
.. _command-lobotomy-remove:
lobotomy remove [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -43,7 +43,7 @@ bot, making it respond to requests made in the channel again.
itself.
.. command-lobotomy-add:
.. _command-lobotomy-add:
lobotomy add [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
@ -54,7 +54,7 @@ channel. *<channel>* is only necessary if the message isn't sent in
the channel itself.
.. command-deop:
.. _command-deop:
deop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -64,7 +64,7 @@ privileges from all the nicks given. If no nicks are given, removes
operator privileges from the person sending the message.
.. command-nicks:
.. _command-nicks:
nicks [<channel>] [--count]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -74,7 +74,7 @@ message isn't sent in the channel itself. Returns only the number of
nicks if *--count* option is provided.
.. command-limit:
.. _command-limit:
limit [<channel>] [<limit>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -84,7 +84,7 @@ removes the channel limit. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. command-moderate:
.. _command-moderate:
moderate [<channel>]
^^^^^^^^^^^^^^^^^^^^
@ -94,7 +94,7 @@ send messages to the channel. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-unban:
.. _command-unban:
unban [<channel>] [<hostmask>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -106,7 +106,7 @@ unexpectedly (or accidentally) banned from the channel. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. command-kick:
.. _command-kick:
kick [<channel>] <nick>[, <nick>, ...] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -117,7 +117,7 @@ uses the nick of the person making the command as the reason.
itself.
.. command-enable:
.. _command-enable:
enable [<channel>] [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -129,7 +129,7 @@ provided, all commands in the given plugin will be enabled. *<channel>*
is only necessary if the message isn't sent in the channel itself.
.. command-invite:
.. _command-invite:
invite [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -139,7 +139,7 @@ to join *<channel>*. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. command-dehalfop:
.. _command-dehalfop:
dehalfop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -149,7 +149,7 @@ privileges from all the nicks given. If no nicks are given, removes
half-operator privileges from the person sending the message.
.. command-alert:
.. _command-alert:
alert [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -158,7 +158,7 @@ Sends *<text>* to all the users in *<channel>* who have the *<channel>*,op
capability.
.. command-disable:
.. _command-disable:
disable [<channel>] [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -170,7 +170,7 @@ given plugin will be disabled. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-key:
.. _command-key:
key [<channel>] [<key>]
^^^^^^^^^^^^^^^^^^^^^^^
@ -180,7 +180,7 @@ the keyword requirement to join *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. command-ignore-list:
.. _command-ignore-list:
ignore list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
@ -190,7 +190,7 @@ Lists the hostmasks that the bot is ignoring on the given channel.
channel itself.
.. command-ignore-remove:
.. _command-ignore-remove:
ignore remove [<channel>] <hostmask>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -200,7 +200,7 @@ persistent ignore on *<hostmask>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-ignore-add:
.. _command-ignore-add:
ignore add [<channel>] <nick|hostmask> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -214,7 +214,7 @@ it isn't given, the ignore will never automatically expire.
channel itself.
.. command-cycle:
.. _command-cycle:
cycle [<channel>]
^^^^^^^^^^^^^^^^^
@ -224,7 +224,7 @@ If you have the #channel,op capability, this will cause the bot to
if the message isn't sent in the channel itself.
.. command-capability-set:
.. _command-capability-set:
capability set [<channel>] <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -234,7 +234,7 @@ capability *<capability>* for all users in the channel. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. command-capability-setdefault:
.. _command-capability-setdefault:
capability setdefault [<channel>] {True|False}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -245,7 +245,7 @@ capabilities to be the value you give. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. command-capability-list:
.. _command-capability-list:
capability list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -254,7 +254,7 @@ Returns the capabilities present on the *<channel>*. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. command-capability-remove:
.. _command-capability-remove:
capability remove [<channel>] <name|hostmask> <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -265,7 +265,7 @@ maps) the capability *<capability>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-capability-add:
.. _command-capability-add:
capability add [<channel>] <nick|username> <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -276,7 +276,7 @@ the capability *<capability>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-capability-unset:
.. _command-capability-unset:
capability unset [<channel>] <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -287,7 +287,7 @@ channel default capability will take precedence. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-kban:
.. _command-kban:
kban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -303,7 +303,7 @@ the kick.
itself.
.. command-halfop:
.. _command-halfop:
halfop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -314,7 +314,7 @@ will give you halfops. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. command-mode:
.. _command-mode:
mode [<channel>] <mode> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -324,7 +324,7 @@ Sets the mode in *<channel>* to *<mode>*, sending the arguments given.
itself.
.. command-ban-list:
.. _command-ban-list:
ban list [<channel>]
^^^^^^^^^^^^^^^^^^^^
@ -333,7 +333,7 @@ If you have the #channel,op capability, this will show you the
current persistent bans on #channel.
.. command-ban-remove:
.. _command-ban-remove:
ban remove [<channel>] <hostmask>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -343,7 +343,7 @@ persistent ban on *<hostmask>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-ban-add:
.. _command-ban-add:
ban add [<channel>] <nick|hostmask> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -359,7 +359,7 @@ expire; if none is given, the ban will never automatically expire.
channel itself.
.. command-voice:
.. _command-voice:
voice [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -370,7 +370,7 @@ voice you. *<channel>* is only necessary if the message isn't sent in the
channel itself.
.. command-op:
.. _command-op:
op [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^

8
use/plugins/channellogger.rst
View File

@ -4,28 +4,28 @@
The ChannelLogger plugin
========================
.. command-timestamp:
.. _command-timestamp:
timestamp
^^^^^^^^^^
.. command-flush:
.. _command-flush:
flush
^^^^^^
.. command-reset:
.. _command-reset:
reset
^^^^^^
.. command-die:
.. _command-die:
die
^^^^

8
use/plugins/channelstats.rst
View File

@ -4,7 +4,7 @@
The ChannelStats plugin
=======================
.. command-stats:
.. _command-stats:
stats [<channel>] [<name>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -14,14 +14,14 @@ 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-die:
.. _command-die:
die
^^^^
.. command-rank:
.. _command-rank:
rank [<channel>] <stat expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -33,7 +33,7 @@ Valid variables in the stat expression include 'msgs', 'chars',
expression involving those variables is permitted.
.. command-channelstats:
.. _command-channelstats:
channelstats [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^

34
use/plugins/conditional.rst
View File

@ -4,7 +4,7 @@
The Conditional plugin
======================
.. command-gt:
.. _command-gt:
gt <item1> <item2>
@ -14,7 +14,7 @@ gt <item1> <item2>
.. command-nlt:
.. _command-nlt:
nlt <item1> <item2>
@ -24,7 +24,7 @@ nlt <item1> <item2>
.. command-nne:
.. _command-nne:
nne <item1> <item2>
@ -34,7 +34,7 @@ nne <item1> <item2>
.. command-ge:
.. _command-ge:
ge <item1> <item2>
@ -44,7 +44,7 @@ ge <item1> <item2>
.. command-cor:
.. _command-cor:
cor <cond1> [<cond2> ... <condN>]
@ -53,7 +53,7 @@ cor <cond1> [<cond2> ... <condN>]
.. command-nle:
.. _command-nle:
nle <item1> <item2>
@ -63,7 +63,7 @@ nle <item1> <item2>
.. command-ceq:
.. _command-ceq:
ceq <item1> <item2>
@ -73,7 +73,7 @@ ceq <item1> <item2>
.. command-nge:
.. _command-nge:
nge <item1> <item2>
@ -83,7 +83,7 @@ nge <item1> <item2>
.. command-cxor:
.. _command-cxor:
cxor <cond1> [<cond2> ... <condN>]
@ -92,7 +92,7 @@ cxor <cond1> [<cond2> ... <condN>]
.. command-le:
.. _command-le:
le <item1> <item2>
@ -102,7 +102,7 @@ le <item1> <item2>
.. command-cif:
.. _command-cif:
cif <condition> <ifcommand> <elsecommand>
@ -115,7 +115,7 @@ cif <condition> <ifcommand> <elsecommand>
.. command-ne:
.. _command-ne:
ne <item1> <item2>
@ -125,7 +125,7 @@ ne <item1> <item2>
.. command-cand:
.. _command-cand:
cand <cond1> [<cond2> ... <condN>]
@ -134,7 +134,7 @@ cand <cond1> [<cond2> ... <condN>]
.. command-nceq:
.. _command-nceq:
nceq <item1> <item2>
@ -144,7 +144,7 @@ nceq <item1> <item2>
.. command-ngt:
.. _command-ngt:
ngt <item1> <item2>
@ -154,7 +154,7 @@ ngt <item1> <item2>
.. command-lt:
.. _command-lt:
lt <item1> <item2>
@ -164,7 +164,7 @@ lt <item1> <item2>
.. command-match:
.. _command-match:
match <item1> <item2>

16
use/plugins/config.rst
View File

@ -4,7 +4,7 @@
The Config plugin
=================
.. command-help:
.. _command-help:
help <name>
^^^^^^^^^^^
@ -12,7 +12,7 @@ help <name>
Returns the description of the configuration variable *<name>*.
.. command-default:
.. _command-default:
default <name>
^^^^^^^^^^^^^^
@ -20,7 +20,7 @@ default <name>
Returns the default value of the configuration variable *<name>*.
.. command-list:
.. _command-list:
list <group>
^^^^^^^^^^^^
@ -32,7 +32,7 @@ it can be separately configured for each channel using the 'channel'
command in this plugin, it is preceded by an '#' sign.
.. command-search:
.. _command-search:
search <word>
^^^^^^^^^^^^^
@ -40,7 +40,7 @@ search <word>
Searches for *<word>* in the current configuration variables.
.. command-reload:
.. _command-reload:
reload
^^^^^^
@ -49,7 +49,7 @@ Reloads the various configuration files (user database, channel
database, registry, etc.).
.. command-export:
.. _command-export:
export <filename>
^^^^^^^^^^^^^^^^^
@ -61,7 +61,7 @@ command will export a "sanitized" configuration file suitable for
showing publicly.
.. command-channel:
.. _command-channel:
channel [<channel>] <name> [<value>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -71,7 +71,7 @@ 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:
.. _command-config:
config <name> [<value>]
^^^^^^^^^^^^^^^^^^^^^^^

2
use/plugins/ctcp.rst
View File

@ -4,7 +4,7 @@
The Ctcp plugin
===============
.. command-version:
.. _command-version:
version [<channel>] [--nicks]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

8
use/plugins/dict.rst
View File

@ -4,7 +4,7 @@
The Dict plugin
===============
.. command-synonym:
.. _command-synonym:
synonym <word> [<word> ...]
Gets a random synonym from the Moby Thesaurus (moby-thes) database.
@ -16,7 +16,7 @@ synonym <word> [<word> ...]
.. command-dict:
.. _command-dict:
dict [<dictionary>] <word>
^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -25,7 +25,7 @@ Looks up the definition of *<word>* on the dictd server specified by
the supybot.plugins.Dict.server config variable.
.. command-random:
.. _command-random:
random
^^^^^^
@ -33,7 +33,7 @@ random
Returns a random valid dictionary.
.. command-dictionaries:
.. _command-dictionaries:
dictionaries
^^^^^^^^^^^^

22
use/plugins/factoids.rst
View File

@ -4,7 +4,7 @@
The Factoids plugin
===================
.. command-info:
.. _command-info:
info [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^
@ -14,14 +14,14 @@ Gives information about the factoid(s) associated with *<key>*.
itself.
.. command-learn:
.. _command-learn:
learn
^^^^^^
.. command-forget:
.. _command-forget:
forget [<channel>] <key> [<number>|*]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -38,7 +38,7 @@ a factoid (key), it shall be removed from the database.
the message isn't sent in the channel itself.
.. command-random:
.. _command-random:
random [<channel>]
^^^^^^^^^^^^^^^^^^
@ -47,7 +47,7 @@ Returns a random factoid from the database for *<channel>*. *<channel>*
is only necessary if the message isn't sent in the channel itself.
.. command-rank:
.. _command-rank:
rank [<channel>] [--plain] [--alpha] [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -66,7 +66,7 @@ alphabetically, instead of by rank.
itself.
.. command-unlock:
.. _command-unlock:
unlock [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -76,7 +76,7 @@ removed or added to. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. command-search:
.. _command-search:
search [<channel>] [--values] [--{regexp} <value>] [<glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -86,7 +86,7 @@ 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-whatis:
.. _command-whatis:
whatis [<channel>] [--raw] <key> [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -98,7 +98,7 @@ given, no variable substitution will take place on the factoid.
itself.
.. command-alias:
.. _command-alias:
alias [<channel>] <oldkey> <newkey> [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -111,7 +111,7 @@ The same action can be accomplished by using the 'learn' function with
a new key but an existing (verbatim) factoid content.
.. command-change:
.. _command-change:
change [<channel>] <key> <number> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -120,7 +120,7 @@ Changes the factoid #*<number>* associated with *<key>* according to
*<regexp>*.
.. command-lock:
.. _command-lock:
lock [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^

48
use/plugins/filter.rst
View File

@ -4,7 +4,7 @@
The Filter plugin
=================
.. command-undup:
.. _command-undup:
undup <text>
^^^^^^^^^^^^
@ -12,7 +12,7 @@ undup <text>
Returns *<text>*, with all consecutive duplicated letters removed.
.. command-unhexlify:
.. _command-unhexlify:
unhexlify <hexstring>
^^^^^^^^^^^^^^^^^^^^^
@ -21,7 +21,7 @@ Returns the string corresponding to *<hexstring>*. Obviously,
*<hexstring>* must be a string of hexadecimal digits.
.. command-stripcolor:
.. _command-stripcolor:
stripcolor <text>
^^^^^^^^^^^^^^^^^
@ -29,7 +29,7 @@ stripcolor <text>
Returns *<text>* stripped of all color codes.
.. command-unbinary:
.. _command-unbinary:
unbinary <text>
^^^^^^^^^^^^^^^
@ -38,7 +38,7 @@ Returns the character representation of binary *<text>*.
Assumes ASCII, 8 digits per character.
.. command-hebrew:
.. _command-hebrew:
hebrew <text>
^^^^^^^^^^^^^
@ -48,7 +48,7 @@ named 'hebrew' it's because I (jemfinch) thought of it in Hebrew class,
and printed Hebrew often elides the vowels.)
.. command-colorize:
.. _command-colorize:
colorize <text>
^^^^^^^^^^^^^^^
@ -56,7 +56,7 @@ colorize <text>
Returns *<text>* with each character randomly colorized.
.. command-binary:
.. _command-binary:
binary <text>
^^^^^^^^^^^^^
@ -64,7 +64,7 @@ binary <text>
Returns the binary representation of *<text>*.
.. command-leet:
.. _command-leet:
leet <text>
^^^^^^^^^^^
@ -72,7 +72,7 @@ leet <text>
Returns the l33tspeak version of *<text>*
.. command-lithp:
.. _command-lithp:
lithp <text>
^^^^^^^^^^^^
@ -80,7 +80,7 @@ lithp <text>
Returns the lisping version of *<text>*
.. command-morse:
.. _command-morse:
morse <text>
^^^^^^^^^^^^
@ -88,7 +88,7 @@ morse <text>
Gives the Morse code equivalent of a given string.
.. command-outfilter:
.. _command-outfilter:
outfilter [<channel>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -98,7 +98,7 @@ given, unsets the outFilter. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-spellit:
.. _command-spellit:
spellit <text>
^^^^^^^^^^^^^^
@ -106,7 +106,7 @@ spellit <text>
Returns *<text>*, phonetically spelled out.
.. command-rainbow:
.. _command-rainbow:
rainbow <text>
^^^^^^^^^^^^^^
@ -114,7 +114,7 @@ rainbow <text>
Returns *<text>* colorized like a rainbow.
.. command-aol:
.. _command-aol:
aol <text>
^^^^^^^^^^
@ -122,7 +122,7 @@ aol <text>
Returns *<text>* as if an AOLuser had said it.
.. command-hexlify:
.. _command-hexlify:
hexlify <text>
^^^^^^^^^^^^^^
@ -131,7 +131,7 @@ Returns a hexstring from the given string; a hexstring is a string
composed of the hexadecimal value of each character in the string
.. command-unmorse:
.. _command-unmorse:
unmorse <Morse code text>
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -139,7 +139,7 @@ unmorse <Morse code text>
Does the reverse of the morse command.
.. command-squish:
.. _command-squish:
squish <text>
^^^^^^^^^^^^^
@ -147,7 +147,7 @@ squish <text>
Removes all the spaces from *<text>*.
.. command-reverse:
.. _command-reverse:
reverse <text>
^^^^^^^^^^^^^^
@ -155,7 +155,7 @@ reverse <text>
Reverses *<text>*.
.. command-azn:
.. _command-azn:
azn <text>
^^^^^^^^^^
@ -163,7 +163,7 @@ azn <text>
Returns *<text>* with the l's made into r's and r's made into l's.
.. command-gnu:
.. _command-gnu:
gnu <text>
^^^^^^^^^^
@ -171,7 +171,7 @@ gnu <text>
Returns *<text>* as GNU/RMS would say it.
.. command-jeffk:
.. _command-jeffk:
jeffk <text>
^^^^^^^^^^^^
@ -179,7 +179,7 @@ jeffk <text>
Returns *<text>* as if JeffK had said it himself.
.. command-shrink:
.. _command-shrink:
shrink <text>
^^^^^^^^^^^^^
@ -189,7 +189,7 @@ supybot.plugins.Filter.shrink.minimum being shrunken (i.e., like
"internationalization" becomes "i18n").
.. command-uniud:
.. _command-uniud:
uniud <text>
^^^^^^^^^^^^
@ -198,7 +198,7 @@ Returns *<text>* rotated 180 degrees. Only really works for ASCII
printable characters.
.. command-scramble:
.. _command-scramble:
scramble <text>
^^^^^^^^^^^^^^^

32
use/plugins/format.rst
View File

@ -4,7 +4,7 @@
The Format plugin
=================
.. command-upper:
.. _command-upper:
upper <text>
^^^^^^^^^^^^
@ -12,7 +12,7 @@ upper <text>
Returns *<text>* uppercased.
.. command-bold:
.. _command-bold:
bold <text>
^^^^^^^^^^^
@ -20,7 +20,7 @@ bold <text>
Returns *<text>* bolded.
.. command-format:
.. _command-format:
format <format string> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -30,7 +30,7 @@ sure always to use %s, not %d or %f or whatever, because all the args
are strings.
.. command-color:
.. _command-color:
color <foreground> [<background>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -39,7 +39,7 @@ Returns *<text>* with foreground color *<foreground>* and background color
*<background>* (if given)
.. command-repr:
.. _command-repr:
repr <text>
^^^^^^^^^^^
@ -47,7 +47,7 @@ repr <text>
Returns the text surrounded by double quotes.
.. command-replace:
.. _command-replace:
replace <substring to translate> <substring to replace it with> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -56,7 +56,7 @@ Replaces all non-overlapping occurrences of *<substring to translate>*
with *<substring to replace it with>* in *<text>*.
.. command-capitalize:
.. _command-capitalize:
capitalize <text>
^^^^^^^^^^^^^^^^^
@ -64,7 +64,7 @@ capitalize <text>
Returns *<text>* capitalized.
.. command-underline:
.. _command-underline:
underline <text>
^^^^^^^^^^^^^^^^
@ -72,7 +72,7 @@ underline <text>
Returns *<text>* underlined.
.. command-lower:
.. _command-lower:
lower <text>
^^^^^^^^^^^^
@ -80,7 +80,7 @@ lower <text>
Returns *<text>* lowercased.
.. command-cut:
.. _command-cut:
cut <size> <text>
^^^^^^^^^^^^^^^^^
@ -90,7 +90,7 @@ excess of *<size>*. If *<size>* is a negative number, it chops that many
characters off the end of *<text>*.
.. command-join:
.. _command-join:
join <separator> <string 1> [<string> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -98,7 +98,7 @@ join <separator> <string 1> [<string> ...]
Joins all the arguments together with *<separator>*.
.. command-reverse:
.. _command-reverse:
reverse <text>
^^^^^^^^^^^^^^
@ -106,7 +106,7 @@ reverse <text>
Returns *<text>* in reverse-video.
.. command-title:
.. _command-title:
title <text>
^^^^^^^^^^^^
@ -114,7 +114,7 @@ title <text>
Returns *<text>* titlecased.
.. command-field:
.. _command-field:
field <number> <text>
^^^^^^^^^^^^^^^^^^^^^
@ -123,7 +123,7 @@ 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-concat:
.. _command-concat:
concat <string 1> <string 2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -133,7 +133,7 @@ thing as join "", since if *<string 2>* contains spaces, they won't be
removed by concat.
.. command-translate:
.. _command-translate:
translate <chars to translate> <chars to replace those with> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

10
use/plugins/games.rst
View File

@ -4,7 +4,7 @@
The Games plugin
================
.. command-dice:
.. _command-dice:
dice <dice>d<sides>
^^^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ For example, 2d6 will roll 2 six-sided dice; 10d10 will roll 10
ten-sided dice.
.. command-roulette:
.. _command-roulette:
roulette [spin]
^^^^^^^^^^^^^^^
@ -23,7 +23,7 @@ Fires the revolver. If the bullet was in the chamber, you're dead.
Tell me to spin the chambers and I will.
.. command-eightball:
.. _command-eightball:
eightball [<question>]
^^^^^^^^^^^^^^^^^^^^^^
@ -31,7 +31,7 @@ eightball [<question>]
Ask a question and the answer shall be provided.
.. command-monologue:
.. _command-monologue:
monologue [<channel>]
^^^^^^^^^^^^^^^^^^^^^
@ -42,7 +42,7 @@ without being interrupted by someone else (i.e. how long your current
in the channel itself.
.. command-coin:
.. _command-coin:
coin
^^^^

16
use/plugins/google.rst
View File

@ -4,7 +4,7 @@
The Google plugin
=================
.. command-google:
.. _command-google:
google <search> [--{filter,language} <value>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ are included. *--language* accepts a language abbreviation; *--filter
accepts* a filtering level ('active', 'moderate', 'off').
.. command-search:
.. _command-search:
search Perform a search using Google's AJAX API.
search("search phrase", options={})
@ -27,7 +27,7 @@ language - Restrict search to documents in the given language
(Default: "lang_en")
.. command-cache:
.. _command-cache:
cache <url>
^^^^^^^^^^^
@ -35,7 +35,7 @@ cache <url>
Returns a link to the cached version of *<url>* if it is available.
.. command-lucky:
.. _command-lucky:
lucky [--snippet] <search>
^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -44,7 +44,7 @@ Does a google search, but only returns the first result.
If option *--snippet* is given, returns also the page text snippet.
.. command-fight:
.. _command-fight:
fight <search string> <search string> [<search string> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -53,7 +53,7 @@ Returns the results of each search, in order, from greatest number
of results to least.
.. command-phonebook:
.. _command-phonebook:
phonebook <phone number>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -61,7 +61,7 @@ phonebook <phone number>
Looks *<phone number>* up on Google.
.. command-calc:
.. _command-calc:
calc <expression>
^^^^^^^^^^^^^^^^^
@ -69,7 +69,7 @@ calc <expression>
Uses Google's calculator to calculate the value of *<expression>*.
.. command-translate:
.. _command-translate:
translate <from-language> [to] <to-language> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

12
use/plugins/herald.rst
View File

@ -4,7 +4,7 @@
The Herald plugin
=================
.. command-get:
.. _command-get:
get [<channel>] [<user|nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -15,14 +15,14 @@ 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-die:
.. _command-die:
die
^^^^
.. command-remove:
.. _command-remove:
remove [<channel>] [<user|nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -34,7 +34,7 @@ is not given, defaults to the user giving the command.
itself.
.. command-default:
.. _command-default:
default [<channel>] [--remove|<msg>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -45,7 +45,7 @@ current default herald. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. command-add:
.. _command-add:
add [<channel>] <user|nick> <msg>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -55,7 +55,7 @@ currently identified or recognized as) to *<msg>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-change:
.. _command-change:
change [<channel>] [<user|nick>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

6
use/plugins/internet.rst
View File

@ -4,7 +4,7 @@
The Internet plugin
===================
.. command-whois:
.. _command-whois:
whois <domain>
^^^^^^^^^^^^^^
@ -12,7 +12,7 @@ whois <domain>
Returns WHOIS information on the registration of *<domain>*.
.. command-dns:
.. _command-dns:
dns <host|ip>
^^^^^^^^^^^^^
@ -20,7 +20,7 @@ dns <host|ip>
Returns the ip of *<host>* or the reverse DNS hostname of *<ip>*.
.. command-hexip:
.. _command-hexip:
hexip <ip>
^^^^^^^^^^

12
use/plugins/karma.rst
View File

@ -4,7 +4,7 @@
The Karma plugin
================
.. command-load:
.. _command-load:
load [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.
.. command-dump:
.. _command-dump:
dump [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -24,14 +24,14 @@ data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.
.. command-die:
.. _command-die:
die
^^^^
.. command-clear:
.. _command-clear:
clear [<channel>] <name>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -39,7 +39,7 @@ clear [<channel>] <name>
Resets the karma of *<name>* to 0.
.. command-most:
.. _command-most:
most [<channel>] {increased,decreased,active}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -49,7 +49,7 @@ Returns the most increased, the most decreased, or the most active
necessary if the message isn't sent in the channel itself.
.. command-karma:
.. _command-karma:
karma [<channel>] [<thing> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

2
use/plugins/lart.rst
View File

@ -4,7 +4,7 @@
The Lart plugin
===============
.. command-lart:
.. _command-lart:
lart [<channel>] [<id>] <who|what> [for <reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

8
use/plugins/later.rst
View File

@ -4,14 +4,14 @@
The Later plugin
================
.. command-die:
.. _command-die:
die
^^^^
.. command-notes:
.. _command-notes:
notes [<nick>]
^^^^^^^^^^^^^^
@ -20,7 +20,7 @@ If *<nick>* is given, replies with what notes are waiting on *<nick>*,
otherwise, replies with the nicks that have notes waiting for them.
.. command-remove:
.. _command-remove:
remove <nick>
^^^^^^^^^^^^^
@ -28,7 +28,7 @@ remove <nick>
Removes the notes waiting on *<nick>*.
.. command-tell:
.. _command-tell:
tell <nick> <text>
^^^^^^^^^^^^^^^^^^

12
use/plugins/math.rst
View File

@ -4,7 +4,7 @@
The Math plugin
===============
.. command-base:
.. _command-base:
base <fromBase> [<toBase>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -13,7 +13,7 @@ Converts *<number>* from base *<fromBase>* to base *<toBase>*.
If *<toBase>* is left out, it converts to decimal.
.. command-rpn:
.. _command-rpn:
rpn <rpn math expression>
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -21,7 +21,7 @@ rpn <rpn math expression>
Returns the value of an RPN expression.
.. command-convert:
.. _command-convert:
convert [<number>] <unit> to <other unit>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -30,7 +30,7 @@ Converts from *<unit>* to *<other unit>*. If number isn't given, it
defaults to 1. For unit information, see 'units' command.
.. command-icalc:
.. _command-icalc:
icalc <math expression>
^^^^^^^^^^^^^^^^^^^^^^^
@ -40,7 +40,7 @@ math, and can thus cause the bot to suck up CPU. Hence it requires
the 'trusted' capability to use.
.. command-units:
.. _command-units:
units [<type>]
^^^^^^^^^^^^^^
@ -50,7 +50,7 @@ passed as arguments. When called with a type as an argument, returns
the units of that type.
.. command-calc:
.. _command-calc:
calc <math expression>
^^^^^^^^^^^^^^^^^^^^^^

18
use/plugins/messageparser.rst
View File

@ -4,7 +4,7 @@
The MessageParser plugin
========================
.. command-show:
.. _command-show:
show [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -15,7 +15,7 @@ itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. command-lock:
.. _command-lock:
lock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -25,7 +25,7 @@ removed or overwritten to. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. command-rank:
.. _command-rank:
rank [<channel>]
^^^^^^^^^^^^^^^^
@ -36,7 +36,7 @@ rankListLength registry value. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-unlock:
.. _command-unlock:
unlock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -46,7 +46,7 @@ removed or overwritten. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. command-vacuum:
.. _command-vacuum:
vacuum [<channel>]
^^^^^^^^^^^^^^^^^^
@ -59,7 +59,7 @@ First check if user has the required capability specified in plugin
config requireVacuumCapability.
.. command-info:
.. _command-info:
info [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -70,7 +70,7 @@ itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. command-list:
.. _command-list:
list [<channel>]
^^^^^^^^^^^^^^^^
@ -80,7 +80,7 @@ Lists regexps present in the triggers database.
itself. Regexp ID listed in paretheses.
.. command-remove:
.. _command-remove:
remove [<channel>] [--id] <regexp>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -91,7 +91,7 @@ the message isn't sent in the channel itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. command-add:
.. _command-add:
add [<channel>] <regexp> <action>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

18
use/plugins/misc.rst
View File

@ -4,7 +4,7 @@
The Misc plugin
===============
.. command-last:
.. _command-last:
last [--{from,in,on,with,without,regexp} <value>] [--nolimit]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -18,7 +18,7 @@ the messages that can be found. By default, the channel this command is
given in is searched.
.. command-help:
.. _command-help:
help [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -27,7 +27,7 @@ This command gives a useful description of what *<command>* does.
*<plugin>* is only necessary if the command is in more than one plugin.
.. command-list:
.. _command-list:
list [--private] [<plugin>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -37,7 +37,7 @@ given, lists the public plugins available. If *--private* is given,
lists the private plugins.
.. command-ping:
.. _command-ping:
ping
^^^^
@ -45,7 +45,7 @@ ping
Checks to see if the bot is alive.
.. command-source:
.. _command-source:
source
^^^^^^
@ -53,7 +53,7 @@ source
Returns a URL saying where to get Supybot.
.. command-version:
.. _command-version:
version
^^^^^^^
@ -61,7 +61,7 @@ version
Returns the version of the current bot.
.. command-apropos:
.. _command-apropos:
apropos <string>
^^^^^^^^^^^^^^^^
@ -70,7 +70,7 @@ Searches for *<string>* in the commands currently offered by the bot,
returning a list of the commands containing that string.
.. command-tell:
.. _command-tell:
tell <nick> <text>
^^^^^^^^^^^^^^^^^^
@ -79,7 +79,7 @@ Tells the *<nick>* whatever *<text>* is. Use nested commands to your
benefit here.
.. command-more:
.. _command-more:
more [<nick>]
^^^^^^^^^^^^^

24
use/plugins/moobotfactoids.rst
View File

@ -4,7 +4,7 @@
The MoobotFactoids plugin
=========================
.. command-lock:
.. _command-lock:
lock [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ be registered and have created the factoid originally. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. command-listauth:
.. _command-listauth:
listauth [<channel>] <author name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -25,7 +25,7 @@ this function (so don't use integer usernames!). *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-random:
.. _command-random:
random [<channel>]
^^^^^^^^^^^^^^^^^^
@ -35,7 +35,7 @@ Displays a random factoid (along with its key) from the database.
itself.
.. command-unlock:
.. _command-unlock:
unlock [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -45,7 +45,7 @@ user be registered and have locked the factoid. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-literal:
.. _command-literal:
literal [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -55,7 +55,7 @@ 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-listvalues:
.. _command-listvalues:
listvalues [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -65,14 +65,14 @@ Lists the keys of the factoids whose value contains the provided text.
itself.
.. command-reset:
.. _command-reset:
reset
^^^^^^
.. command-factinfo:
.. _command-factinfo:
factinfo [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -82,7 +82,7 @@ Returns the various bits of info on the factoid for the given key.
itself.
.. command-most:
.. _command-most:
most [<channel>] {popular|authored|recent}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -94,14 +94,14 @@ the most factoids. "recent" lists the most recently created factoids.
itself.
.. command-die:
.. _command-die:
die
^^^^
.. command-remove:
.. _command-remove:
remove [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -110,7 +110,7 @@ Deletes the factoid with the given key. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. command-listkeys:
.. _command-listkeys:
listkeys [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^

16
use/plugins/network.rst
View File

@ -4,7 +4,7 @@
The Network plugin
==================
.. command-driver:
.. _command-driver:
driver [<network>]
^^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ necessary if the message isn't sent on the network to which this
command is to apply.
.. command-connect:
.. _command-connect:
connect [--ssl] <network> [<host[:port]>] [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -26,7 +26,7 @@ provided, it will be sent to the server in a PASS command. If *--ssl* is
provided, an SSL connection will be attempted.
.. command-reconnect:
.. _command-reconnect:
reconnect [<network>] [<quit message>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -38,7 +38,7 @@ on. If no quit message is given, uses the configured one
command.
.. command-networks:
.. _command-networks:
networks
^^^^^^^^
@ -46,7 +46,7 @@ networks
Returns the networks to which the bot is currently connected.
.. command-latency:
.. _command-latency:
latency [<network>]
^^^^^^^^^^^^^^^^^^^
@ -56,7 +56,7 @@ if the message isn't sent on the network to which this command is to
apply.
.. command-disconnect:
.. _command-disconnect:
disconnect [<network>] [<quit message>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -67,7 +67,7 @@ message. *<network>* is only necessary if the network is different
from the network the command is sent on.
.. command-whois:
.. _command-whois:
whois [<network>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -77,7 +77,7 @@ only necessary if the network is different than the network the command
is sent on.
.. command-command:
.. _command-command:
command <network> <command> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

12
use/plugins/news.rst
View File

@ -4,7 +4,7 @@
The News plugin
===============
.. command-old:
.. _command-old:
old [<channel>] [<id>]
^^^^^^^^^^^^^^^^^^^^^^
@ -14,14 +14,14 @@ 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-die:
.. _command-die:
die
^^^^
.. command-remove:
.. _command-remove:
remove [<channel>] <id>
^^^^^^^^^^^^^^^^^^^^^^^
@ -30,7 +30,7 @@ Removes the news item with *<id>* from *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-add:
.. _command-add:
add [<channel>] <expires> <subject>: <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -41,7 +41,7 @@ now. *<channel>* is only necessary if the message isn't sent in the
channel itself.
.. command-news:
.. _command-news:
news [<channel>] [<id>]
^^^^^^^^^^^^^^^^^^^^^^^
@ -52,7 +52,7 @@ news items. *<channel>* is only necessary if the message isn't sent in
the channel itself.
.. command-change:
.. _command-change:
change [<channel>] <id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

4
use/plugins/nickometer.rst
View File

@ -4,14 +4,14 @@
The Nickometer plugin
=====================
.. command-punish:
.. _command-punish:
punish
^^^^^^^
.. command-nickometer:
.. _command-nickometer:
nickometer [<nick>]
^^^^^^^^^^^^^^^^^^^

16
use/plugins/note.rst
View File

@ -4,7 +4,7 @@
The Note plugin
===============
.. command-unsend:
.. _command-unsend:
unsend <id>
^^^^^^^^^^^
@ -13,7 +13,7 @@ Unsends the note with the id given. You must be the
author of the note, and it must be unread.
.. command-search:
.. _command-search:
search [--{regexp} <value>] [--sent] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -23,7 +23,7 @@ given, its associated value is taken as a regexp and matched against
the notes. If *--sent* is specified, only search sent notes.
.. command-reply:
.. _command-reply:
reply <id> <text>
^^^^^^^^^^^^^^^^^
@ -31,14 +31,14 @@ reply <id> <text>
Sends a note in reply to *<id>*.
.. command-die:
.. _command-die:
die
^^^^
.. command-list:
.. _command-list:
list [--{old,sent}] [--{from,to} <user>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -49,7 +49,7 @@ read notes. If *--sent* is given, list notes that you have sent. If
*--to* is specified, only lists notes sent by you to *<user>*.
.. command-send:
.. _command-send:
send <recipient>,[<recipient>,[...]] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -58,7 +58,7 @@ Sends a new note to the user specified. Multiple recipients may be
specified by separating their names by commas.
.. command-next:
.. _command-next:
next
^^^^
@ -66,7 +66,7 @@ next
Retrieves your next unread note, if any.
.. command-note:
.. _command-note:
note <id>
^^^^^^^^^

34
use/plugins/owner.rst
View File

@ -4,7 +4,7 @@
The Owner plugin
================
.. command-load:
.. _command-load:
load [--deprecated] <plugin>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -15,7 +15,7 @@ installed directory and 'plugins' in the current directory.
*--deprecated* is necessary if you wish to load deprecated plugins.
.. command-rename:
.. _command-rename:
rename <plugin> <command> <new name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -23,7 +23,7 @@ rename <plugin> <command> <new name>
Renames *<command>* in *<plugin>* to the *<new name>*.
.. command-enable:
.. _command-enable:
enable [<plugin>] <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -33,7 +33,7 @@ if given, only enables the *<command>* from *<plugin>*. This command is
the inverse of disable.
.. command-defaultcapability:
.. _command-defaultcapability:
defaultcapability {add|remove} <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -43,14 +43,14 @@ default capabilities given to users (the configuration variable
supybot.capabilities stores these).
.. command-reloadlocale:
.. _command-reloadlocale:
reloadlocale takes no argument
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Reloads the locale of the bot.
.. command-ircquote:
.. _command-ircquote:
ircquote <string to be sent to the server>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -58,7 +58,7 @@ ircquote <string to be sent to the server>
Sends the raw string given to the server.
.. command-disable:
.. _command-disable:
disable [<plugin>] <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -70,7 +70,7 @@ a default capability of -plugin.command or -command (if you want to
disable the command in all plugins).
.. command-upkeep:
.. _command-upkeep:
upkeep [<level>]
^^^^^^^^^^^^^^^^
@ -81,7 +81,7 @@ level is "high", which causes the bot to flush a lot of caches as well
as do normal upkeep stuff.
.. command-flush:
.. _command-flush:
flush
^^^^^
@ -90,7 +90,7 @@ Runs all the periodic flushers in world.flushers. This includes
flushing all logs and all configuration changes to disk.
.. command-unrename:
.. _command-unrename:
unrename <plugin>
^^^^^^^^^^^^^^^^^
@ -99,14 +99,14 @@ Removes all renames in *<plugin>*. The plugin will be reloaded after
this command is run.
.. command-reset:
.. _command-reset:
reset
^^^^^^
.. command-quit:
.. _command-quit:
quit [<text>]
^^^^^^^^^^^^^
@ -116,7 +116,7 @@ the default quit message (supybot.plugins.Owner.quitMsg) will be used.
If there is no default quitMsg set, your nick will be used.
.. command-unload:
.. _command-unload:
unload <plugin>
^^^^^^^^^^^^^^^
@ -126,7 +126,7 @@ of the currently loaded callbacks. Obviously, the Owner plugin can't
be unloaded.
.. command-reload:
.. _command-reload:
reload <plugin>
^^^^^^^^^^^^^^^
@ -135,7 +135,7 @@ Unloads and subsequently reloads the plugin by name; use the 'list'
command to see a list of the currently loaded plugins.
.. command-announce:
.. _command-announce:
announce <text>
^^^^^^^^^^^^^^^
@ -144,7 +144,7 @@ Sends *<text>* to all channels the bot is currently on and not
lobotomized in.
.. command-defaultplugin:
.. _command-defaultplugin:
defaultplugin [--remove] <command> [<plugin>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -155,7 +155,7 @@ is given, returns the current default plugin set for *<command>*. See
also, supybot.commands.defaultPlugins.importantPlugins.
.. command-logmark:
.. _command-logmark:
logmark <text>
^^^^^^^^^^^^^^

12
use/plugins/plugin.rst
View File

@ -4,7 +4,7 @@
The Plugin plugin
=================
.. command-help:
.. _command-help:
help <plugin>
^^^^^^^^^^^^^
@ -13,7 +13,7 @@ Returns a useful description of how to use *<plugin>*, if the plugin has
one.
.. command-contributors:
.. _command-contributors:
contributors <plugin> [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -24,7 +24,7 @@ be listed. Note: The *<nick>* is the part inside of the parentheses
in the people listing.
.. command-plugin:
.. _command-plugin:
plugin <command>
^^^^^^^^^^^^^^^^
@ -35,7 +35,7 @@ If it is not uniquely determined, returns list of all plugins that
contain *<command>*.
.. command-author:
.. _command-author:
author <plugin>
^^^^^^^^^^^^^^^
@ -44,7 +44,7 @@ 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.
.. command-list:
.. _command-list:
list
^^^^
@ -52,7 +52,7 @@ list
Returns a list of the currently loaded plugins.
.. command-plugins:
.. _command-plugins:
plugins <command>
^^^^^^^^^^^^^^^^^

4
use/plugins/plugindownloader.rst
View File

@ -4,14 +4,14 @@
The PluginDownloader plugin
===========================
.. command-install:
.. _command-install:
install <repository> <plugin>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Downloads and installs the *<plugin>* from the *<repository>*.
.. command-repolist:
.. _command-repolist:
repolist [<repository>]
^^^^^^^^^^^^^^^^^^^^^^^

2
use/plugins/praise.rst
View File

@ -4,7 +4,7 @@
The Praise plugin
=================
.. command-praise:
.. _command-praise:
praise [<channel>] [<id>] <who|what> [for <reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

2
use/plugins/protector.rst
View File

@ -4,7 +4,7 @@
The Protector plugin
====================
.. command-demote:
.. _command-demote:
demote
^^^^^^^

2
use/plugins/quote.rst
View File

@ -4,7 +4,7 @@
The Quote plugin
================
.. command-random:
.. _command-random:
random [<channel>]
^^^^^^^^^^^^^^^^^^

14
use/plugins/quotegrabs.rst
View File

@ -4,7 +4,7 @@
The QuoteGrabs plugin
=====================
.. command-ungrab:
.. _command-ungrab:
ungrab [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ Removes the grab *<number>* (the last by default) on *<channel>*.
itself.
.. command-get:
.. _command-get:
get [<channel>] <id>
^^^^^^^^^^^^^^^^^^^^
@ -23,7 +23,7 @@ Return the quotegrab with the given *<id>*. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. command-quote:
.. _command-quote:
quote [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -32,7 +32,7 @@ Returns *<nick>*'s latest quote grab in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-random:
.. _command-random:
random [<channel>] [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -42,7 +42,7 @@ quotes grabbed for *<nick>*. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. command-list:
.. _command-list:
list [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^
@ -53,7 +53,7 @@ full quote. *<channel>* is only necessary if the message isn't sent in
the channel itself.
.. command-search:
.. _command-search:
search [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -62,7 +62,7 @@ Searches for *<text>* in a quote. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-grab:
.. _command-grab:
grab [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^

6
use/plugins/relay.rst
View File

@ -4,7 +4,7 @@
The Relay plugin
================
.. command-nicks:
.. _command-nicks:
nicks [<channel>]
^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ the bot is connected to. *<channel>* is only necessary if the message
isn't sent on the channel itself.
.. command-part:
.. _command-part:
part <channel>
^^^^^^^^^^^^^^
@ -24,7 +24,7 @@ will part from the channel on all networks in which it is on the
channel.
.. command-join:
.. _command-join:
join [<channel>]
^^^^^^^^^^^^^^^^

10
use/plugins/reply.rst
View File

@ -4,7 +4,7 @@
The Reply plugin
================
.. command-notice:
.. _command-notice:
notice <text>
^^^^^^^^^^^^^
@ -13,7 +13,7 @@ Replies with *<text>* in a notice. Use nested commands to your benefit
here. If you want a private notice, nest the private command.
.. command-private:
.. _command-private:
private <text>
^^^^^^^^^^^^^^
@ -22,7 +22,7 @@ Replies with *<text>* in private. Use nested commands to your benefit
here.
.. command-replies:
.. _command-replies:
replies <str> [<str> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -31,7 +31,7 @@ Replies with each of its arguments *<str>* in separate replies, depending
the configuration of supybot.reply.oneToOne.
.. command-action:
.. _command-action:
action <text>
^^^^^^^^^^^^^
@ -40,7 +40,7 @@ Replies with *<text>* as an action. use nested commands to your benefit
here.
.. command-reply:
.. _command-reply:
reply <text>
^^^^^^^^^^^^

14
use/plugins/rss.rst
View File

@ -4,7 +4,7 @@
The RSS plugin
==============
.. command-info:
.. _command-info:
info <url|feed>
^^^^^^^^^^^^^^^
@ -13,7 +13,7 @@ Returns information from the given RSS feed, namely the title,
URL, description, and last update date, if available.
.. command-remove:
.. _command-remove:
remove <name>
^^^^^^^^^^^^^
@ -22,7 +22,7 @@ Removes the command for looking up RSS feeds at *<name>* from
this plugin.
.. command-add:
.. _command-add:
add <name> <url>
^^^^^^^^^^^^^^^^
@ -31,7 +31,7 @@ Adds a command to this plugin that will look up the RSS feed at the
given URL.
.. command-announce-list:
.. _command-announce-list:
announce list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -40,7 +40,7 @@ Returns the list of feeds announced in *<channel>*. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. command-announce-remove:
.. _command-announce-remove:
announce remove [<channel>] <name|url> [<name|url> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -51,7 +51,7 @@ well as URLs for RSS feeds. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-announce-add:
.. _command-announce-add:
announce add [<channel>] <name|url> [<name|url> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -62,7 +62,7 @@ well as URLs for RSS feeds. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-rss:
.. _command-rss:
rss <url> [<number of headlines>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

10
use/plugins/scheduler.rst
View File

@ -4,7 +4,7 @@
The Scheduler plugin
====================
.. command-repeat:
.. _command-repeat:
repeat <name> <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -15,14 +15,14 @@ thereafter). *<name>* is a name by which the command can be
unscheduled.
.. command-die:
.. _command-die:
die
^^^^
.. command-list:
.. _command-list:
list
^^^^
@ -30,7 +30,7 @@ list
Lists the currently scheduled events.
.. command-add:
.. _command-add:
add <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^
@ -42,7 +42,7 @@ command was given in (with no prefixed nick, a consequence of using
echo). Do pay attention to the quotes in that example.
.. command-remove:
.. _command-remove:
remove <id>
^^^^^^^^^^^

12
use/plugins/seen.rst
View File

@ -4,7 +4,7 @@
The Seen plugin
===============
.. command-user:
.. _command-user:
user [<channel>] <name>
^^^^^^^^^^^^^^^^^^^^^^^
@ -16,7 +16,7 @@ that it could be any nick recognized as user *<name>* that was seen.
itself.
.. command-seen:
.. _command-seen:
seen [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^
@ -26,7 +26,7 @@ saying. *<channel>* is only necessary if the message isn't sent on the
channel itself. *<nick>* may contain * as a wildcard.
.. command-any:
.. _command-any:
any [<channel>] [--user <name>] [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -39,7 +39,7 @@ 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-last:
.. _command-last:
last [<channel>]
^^^^^^^^^^^^^^^^
@ -48,14 +48,14 @@ Returns the last thing said in *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. command-die:
.. _command-die:
die
^^^^
.. command-since:
.. _command-since:
since [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^

20
use/plugins/services.rst
View File

@ -4,14 +4,14 @@
The Services plugin
===================
.. command-disabled:
.. _command-disabled:
disabled
^^^^^^^^^
.. command-identify:
.. _command-identify:
identify
^^^^^^^^
@ -19,7 +19,7 @@ identify
Identifies with NickServ using the current nick.
.. command-nicks:
.. _command-nicks:
nicks
^^^^^
@ -28,7 +28,7 @@ Returns the nicks that this plugin is configured to identify and ghost
with.
.. command-unban:
.. _command-unban:
unban [<channel>]
^^^^^^^^^^^^^^^^^
@ -39,14 +39,14 @@ are, if you need this command, you're not sending it in the channel
itself.
.. command-reset:
.. _command-reset:
reset
^^^^^^
.. command-invite:
.. _command-invite:
invite [<channel>]
^^^^^^^^^^^^^^^^^^
@ -57,7 +57,7 @@ are, if you need this command, you're not sending it in the channel
itself.
.. command-password:
.. _command-password:
password <nick> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -66,7 +66,7 @@ Sets the NickServ password for *<nick>* to *<password>*. If *<password>* is
not given, removes *<nick>* from the configured nicks.
.. command-ghost:
.. _command-ghost:
ghost [<nick>]
^^^^^^^^^^^^^^
@ -75,7 +75,7 @@ Ghosts the bot's given nick and takes it. If no nick is given,
ghosts the bot's configured nick and takes it.
.. command-voice:
.. _command-voice:
voice [<channel>]
^^^^^^^^^^^^^^^^^
@ -84,7 +84,7 @@ Attempts to get voiced by ChanServ in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-op:
.. _command-op:
op [<channel>]
^^^^^^^^^^^^^^

8
use/plugins/shrinkurl.rst
View File

@ -4,7 +4,7 @@
The ShrinkUrl plugin
====================
.. command-xrl:
.. _command-xrl:
xrl <url>
^^^^^^^^^
@ -12,14 +12,14 @@ xrl <url>
Returns an xrl.us version of *<url>*.
.. command-die:
.. _command-die:
die
^^^^
.. command-tiny:
.. _command-tiny:
tiny <url>
^^^^^^^^^^
@ -27,7 +27,7 @@ tiny <url>
Returns a TinyURL.com version of *<url>*
.. command-ln:
.. _command-ln:
ln <url>
^^^^^^^^

16
use/plugins/status.rst
View File

@ -4,7 +4,7 @@
The Status plugin
=================
.. command-status:
.. _command-status:
status
^^^^^^
@ -12,7 +12,7 @@ status
Returns the status of the bot.
.. command-cmd:
.. _command-cmd:
cmd
^^^
@ -20,7 +20,7 @@ cmd
Returns some interesting command-related statistics.
.. command-commands:
.. _command-commands:
commands
^^^^^^^^
@ -28,7 +28,7 @@ commands
Returns a list of the commands offered by the bot.
.. command-uptime:
.. _command-uptime:
uptime
^^^^^^
@ -36,7 +36,7 @@ uptime
Returns the amount of time the bot has been running.
.. command-threads:
.. _command-threads:
threads
^^^^^^^
@ -44,7 +44,7 @@ threads
Returns the current threads that are active.
.. command-net:
.. _command-net:
net
^^^
@ -52,7 +52,7 @@ net
Returns some interesting network-related statistics.
.. command-server:
.. _command-server:
server
^^^^^^
@ -60,7 +60,7 @@ server
Returns the server the bot is on.
.. command-cpu:
.. _command-cpu:
cpu
^^^

20
use/plugins/string.rst
View File

@ -4,7 +4,7 @@
The String plugin
=================
.. command-soundex:
.. _command-soundex:
soundex <string> [<length>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -14,7 +14,7 @@ Returns the Soundex hash to a given length. The length defaults to
length, use 0.
.. command-xor:
.. _command-xor:
xor <password> <text>
^^^^^^^^^^^^^^^^^^^^^
@ -24,7 +24,7 @@ http://www.yoe.org/developer/xor.html for information about XOR
encryption.
.. command-re:
.. _command-re:
re <regexp> <text>
^^^^^^^^^^^^^^^^^^
@ -35,7 +35,7 @@ s/regexp/replacement/flags, returns the result of applying such a
regexp to *<text>*.
.. command-levenshtein:
.. _command-levenshtein:
levenshtein <string1> <string2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -44,7 +44,7 @@ Returns the levenshtein distance (also known as the "edit distance"
between *<string1>* and *<string2>*)
.. command-decode:
.. _command-decode:
decode <encoding> <text>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -54,7 +54,7 @@ available in the documentation of the Python codecs module:
*<http://docs.python.org/library/codecs.html#standard-encodings>*.
.. command-sha:
.. _command-sha:
sha <text>
^^^^^^^^^^
@ -64,7 +64,7 @@ http://www.secure-hash-algorithm-md5-sha-1.co.uk/ for more information
about SHA.
.. command-chr:
.. _command-chr:
chr <number>
^^^^^^^^^^^^
@ -72,7 +72,7 @@ chr <number>
Returns the character associated with the 8-bit value *<number>*
.. command-len:
.. _command-len:
len <text>
^^^^^^^^^^
@ -80,7 +80,7 @@ len <text>
Returns the length of *<text>*.
.. command-encode:
.. _command-encode:
encode <encoding> <text>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -90,7 +90,7 @@ available in the documentation of the Python codecs module:
*<http://docs.python.org/library/codecs.html#standard-encodings>*.
.. command-ord:
.. _command-ord:
ord <letter>
^^^^^^^^^^^^

2
use/plugins/success.rst
View File

@ -4,7 +4,7 @@
The Success plugin
==================
.. command-die:
.. _command-die:
die
^^^^

14
use/plugins/time.rst
View File

@ -4,7 +4,7 @@
The Time plugin
===============
.. command-ctime:
.. _command-ctime:
ctime [<seconds since epoch>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -13,7 +13,7 @@ Returns the ctime for *<seconds since epoch>*, or the current ctime if
no *<seconds since epoch>* is given.
.. command-seconds:
.. _command-seconds:
seconds [<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -25,7 +25,7 @@ Useful for scheduling events at a given number of seconds in the
future.
.. command-time:
.. _command-time:
time [<format>] [<seconds since epoch>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -35,7 +35,7 @@ given, uses the configurable format for the current channel. If no
*<seconds since epoch>* time is given, the current time is used.
.. command-elapsed:
.. _command-elapsed:
elapsed <seconds>
^^^^^^^^^^^^^^^^^
@ -44,7 +44,7 @@ Returns a pretty string that is the amount of time represented by
*<seconds>*.
.. command-at:
.. _command-at:
at <time string>
^^^^^^^^^^^^^^^^
@ -54,14 +54,14 @@ Returns the number of seconds since epoch *<time string>* is.
and see if it will work.
.. command-tztime:
.. _command-tztime:
tztime <region>/<city>
^^^^^^^^^^^^^^^^^^^^^^
Takes a city and its region, and returns the locale time.
.. command-until:
.. _command-until:
until <time string>
^^^^^^^^^^^^^^^^^^^

14
use/plugins/todo.rst
View File

@ -4,14 +4,14 @@
The Todo plugin
===============
.. command-die:
.. _command-die:
die
^^^^
.. command-search:
.. _command-search:
search [--{regexp} <value>] [<glob> <glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -21,7 +21,7 @@ its associated value is taken as a regexp and matched against the
tasks.
.. command-remove:
.. _command-remove:
remove <task id> [<task id> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -29,7 +29,7 @@ remove <task id> [<task id> ...]
Removes *<task id>* from your personal todo list.
.. command-add:
.. _command-add:
add [--priority=<num>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -39,7 +39,7 @@ priority argument allows you to set a task as a high or low priority.
Any integer is valid.
.. command-setpriority:
.. _command-setpriority:
setpriority <id> <priority>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -47,7 +47,7 @@ setpriority <id> <priority>
Sets the priority of the todo with the given id to the specified value.
.. command-todo:
.. _command-todo:
todo [<username>] [<task id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -57,7 +57,7 @@ will return a list of task ids that that user has added to their todo
list.
.. command-change:
.. _command-change:
change <task id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^

42
use/plugins/topic.rst
View File

@ -4,7 +4,7 @@
The Topic plugin
================
.. command-restore:
.. _command-restore:
restore [<channel>]
^^^^^^^^^^^^^^^^^^^
@ -13,7 +13,7 @@ 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-set:
.. _command-set:
set [<channel>] [<number>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -23,7 +23,7 @@ sets the entire topic. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. command-shuffle:
.. _command-shuffle:
shuffle [<channel>]
^^^^^^^^^^^^^^^^^^^
@ -32,7 +32,7 @@ Shuffles the topics in *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-lock:
.. _command-lock:
lock [<channel>]
^^^^^^^^^^^^^^^^
@ -41,7 +41,7 @@ Locks the topic (sets the mode +t) in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-replace:
.. _command-replace:
replace [<channel>] <number> <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -49,7 +49,7 @@ replace [<channel>] <number> <topic>
Replaces topic *<number>* with *<topic>*.
.. command-topic:
.. _command-topic:
topic [<channel>]
^^^^^^^^^^^^^^^^^
@ -58,7 +58,7 @@ Returns the topic for *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-unlock:
.. _command-unlock:
unlock [<channel>]
^^^^^^^^^^^^^^^^^^
@ -67,7 +67,7 @@ Unlocks the topic (sets the mode +t) in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. command-redo:
.. _command-redo:
redo [<channel>]
^^^^^^^^^^^^^^^^
@ -76,7 +76,7 @@ Undoes the last undo. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. command-fit:
.. _command-fit:
fit [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^
@ -87,7 +87,7 @@ for the server, topics will be popped until there is enough room.
itself.
.. command-swap:
.. _command-swap:
swap [<channel>] <first topic number> <second topic number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -97,7 +97,7 @@ Swaps the order of the first topic number and the second topic number.
itself.
.. command-reorder:
.. _command-reorder:
reorder [<channel>] <number> [<number> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -108,7 +108,7 @@ Reorders the topics from *<channel>* in the order of the specified
itself.
.. command-get:
.. _command-get:
get [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -118,7 +118,7 @@ index into the topics. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. command-undo:
.. _command-undo:
undo [<channel>]
^^^^^^^^^^^^^^^^
@ -128,7 +128,7 @@ set it. *<channel>* is only necessary if the message isn't sent in the
channel itself.
.. command-add:
.. _command-add:
add [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^
@ -137,7 +137,7 @@ Adds *<topic>* to the topics for *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. command-change:
.. _command-change:
change [<channel>] <number> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -149,7 +149,7 @@ s/regexp/replacement/flags. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. command-insert:
.. _command-insert:
insert [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -159,7 +159,7 @@ currently on *<channel>*. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. command-default:
.. _command-default:
default [<channel>]
^^^^^^^^^^^^^^^^^^^
@ -169,14 +169,14 @@ default topic for a channel may be configured via the configuration
variable supybot.plugins.Topic.default.
.. command-die:
.. _command-die:
die
^^^^
.. command-list:
.. _command-list:
list [<channel>]
^^^^^^^^^^^^^^^^
@ -186,7 +186,7 @@ Mostly useful for topic reordering. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. command-remove:
.. _command-remove:
remove [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -197,7 +197,7 @@ 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-separator:
.. _command-separator:
separator [<channel>] <separator>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

18
use/plugins/unix.rst
View File

@ -4,7 +4,7 @@
The Unix plugin
===============
.. command-fortune:
.. _command-fortune:
fortune
^^^^^^^
@ -12,7 +12,7 @@ fortune
Returns a fortune from the *nix fortune program.
.. command-errno:
.. _command-errno:
errno <error number or code>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -20,7 +20,7 @@ errno <error number or code>
Returns the number of an errno code, or the errno code of a number.
.. command-spell:
.. _command-spell:
spell <word>
^^^^^^^^^^^^
@ -30,7 +30,7 @@ shown are sorted from best to worst in terms of being a likely match
for the spelling of *<word>*.
.. command-pid:
.. _command-pid:
pid
^^^
@ -38,7 +38,7 @@ pid
Returns the current pid of the process for this Supybot.
.. command-call:
.. _command-call:
call <command to call with any arguments>
Calls any command available on the system, and returns its output.
@ -51,7 +51,7 @@ call <command to call with any arguments>
.. command-wtf:
.. _command-wtf:
wtf [is] <something>
^^^^^^^^^^^^^^^^^^^^
@ -61,7 +61,7 @@ appeared in NetBSD 1.5. In most *nices, it's available in some sort
of 'bsdgames' package.
.. command-crypt:
.. _command-crypt:
crypt <password> [<salt>]
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -72,7 +72,7 @@ prepending '$1$' to your salt will cause crypt to return an MD5sum
based crypt rather than the standard DES based crypt.
.. command-progstats:
.. _command-progstats:
progstats
^^^^^^^^^
@ -80,7 +80,7 @@ progstats
Returns various unix-y information on the running supybot process.
.. command-ping:
.. _command-ping:
ping [--c <count>] [--i <interval>] [--t <ttl>] [--W <timeout>] <host or ip>
Sends an ICMP echo request to the specified host.

4
use/plugins/url.rst
View File

@ -4,7 +4,7 @@
The URL plugin
==============
.. command-stats:
.. _command-stats:
stats [<channel>]
^^^^^^^^^^^^^^^^^
@ -13,7 +13,7 @@ Returns the number of URLs in the URL database. *<channel>* is only
required if the message isn't sent in the channel itself.
.. command-last:
.. _command-last:
last [<channel>] [--{from,with,without,near,proto} <value>] [--nolimit]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

32
use/plugins/user.rst
View File

@ -4,7 +4,7 @@
The User plugin
===============
.. command-username:
.. _command-username:
username <hostmask|nick>
^^^^^^^^^^^^^^^^^^^^^^^^
@ -13,7 +13,7 @@ Returns the username of the user specified by *<hostmask>* or *<nick>* if
the user is registered.
.. command-set-password:
.. _command-set-password:
set password [<name>] <old password> <new password>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -25,7 +25,7 @@ user (and the user whose password is being changed isn't that same
owner user), then *<old password>* needn't be correct.
.. command-set-secure:
.. _command-set-secure:
set secure <password> [<True|False>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -38,7 +38,7 @@ recognized. If a specific True/False value is not given, it
inverts the current value.
.. command-stats:
.. _command-stats:
stats
^^^^^
@ -46,7 +46,7 @@ stats
Returns some statistics on the user database.
.. command-hostmask-hostmask:
.. _command-hostmask-hostmask:
hostmask hostmask [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -55,7 +55,7 @@ Returns the hostmask of *<nick>*. If *<nick>* isn't given, return the
hostmask of the person giving the command.
.. command-hostmask-list:
.. _command-hostmask-list:
hostmask list [<name>]
^^^^^^^^^^^^^^^^^^^^^^
@ -65,7 +65,7 @@ isn't specified, returns the hostmasks of the user calling the
command.
.. command-hostmask-add:
.. _command-hostmask-add:
hostmask add [<name>] [<hostmask>] [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -80,7 +80,7 @@ must be sent to the bot privately (not on a channel) since it may
contain a password.
.. command-hostmask-remove:
.. _command-hostmask-remove:
hostmask remove <name> <hostmask> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -93,7 +93,7 @@ sent to the bot privately (not on a channel) since it may contain a
password.
.. command-unregister:
.. _command-unregister:
unregister <name> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -102,7 +102,7 @@ Unregisters *<name>* from the user database. If the user giving this
command is an owner user, the password is not necessary.
.. command-register:
.. _command-register:
register <name> <password>
^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -116,7 +116,7 @@ This command (and all other commands that include a password) must be
sent to the bot privately, not in a channel.
.. command-list:
.. _command-list:
list [--capability=<capability>] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -125,7 +125,7 @@ Returns the valid registered usernames matching *<glob>*. If *<glob>* is
not given, returns all registered usernames.
.. command-capabilities:
.. _command-capabilities:
capabilities [<name>]
^^^^^^^^^^^^^^^^^^^^^
@ -135,7 +135,7 @@ isn't specified, returns the capabilities of the user calling the
command.
.. command-unidentify:
.. _command-unidentify:
unidentify
^^^^^^^^^^
@ -146,7 +146,7 @@ have added hostmasks to your user that can cause the bot to continue to
recognize you.
.. command-identify:
.. _command-identify:
identify <name> <password>
^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -156,7 +156,7 @@ commands that include a password) must be sent to the bot privately,
not in a channel.
.. command-whoami:
.. _command-whoami:
whoami
^^^^^^
@ -164,7 +164,7 @@ whoami
Returns the name of the user calling the command.
.. command-changename:
.. _command-changename:
changename <name> <new name> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

16
use/plugins/utilities.rst
View File

@ -4,7 +4,7 @@
The Utilities plugin
====================
.. command-ignore:
.. _command-ignore:
ignore requires no arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -13,7 +13,7 @@ Does nothing. Useful sometimes for sequencing commands when you don't
care about their non-error return values.
.. command-shuffle:
.. _command-shuffle:
shuffle <arg> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^
@ -21,7 +21,7 @@ shuffle <arg> [<arg> ...]
Shuffles the arguments given.
.. command-success:
.. _command-success:
success [<text>]
^^^^^^^^^^^^^^^^
@ -33,7 +33,7 @@ course, will break out of this command. *<text>*, if given, will be
appended to the end of the success message.
.. command-echo:
.. _command-echo:
echo <text>
^^^^^^^^^^^
@ -44,7 +44,7 @@ $botnick, $channel, $user, $host, $today, $now, and $randomDate are all
handled appropriately.
.. command-sample:
.. _command-sample:
sample <num> <arg> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -52,7 +52,7 @@ sample <num> <arg> [<arg> ...]
Randomly chooses *<num>* items out of the arguments given.
.. command-countargs:
.. _command-countargs:
countargs <arg> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -60,7 +60,7 @@ countargs <arg> [<arg> ...]
Counts the arguments given.
.. command-last:
.. _command-last:
last <text> [<text> ...]
^^^^^^^^^^^^^^^^^^^^^^^^
@ -70,7 +70,7 @@ nested commands to run, but only the output of the last one to be
returned.
.. command-apply:
.. _command-apply:
apply <command> <text>
^^^^^^^^^^^^^^^^^^^^^^

16
use/plugins/web.rst
View File

@ -4,7 +4,7 @@
The Web plugin
==============
.. command-urlunquote:
.. _command-urlunquote:
urlunquote <text>
^^^^^^^^^^^^^^^^^
@ -12,7 +12,7 @@ urlunquote <text>
Returns the text un-URL quoted.
.. command-netcraft:
.. _command-netcraft:
netcraft <hostname|ip>
^^^^^^^^^^^^^^^^^^^^^^
@ -21,7 +21,7 @@ Returns Netcraft.com's determination of what operating system and
webserver is running on the host given.
.. command-urlquote:
.. _command-urlquote:
urlquote <text>
^^^^^^^^^^^^^^^
@ -29,7 +29,7 @@ urlquote <text>
Returns the URL quoted form of the text.
.. command-size:
.. _command-size:
size <url>
^^^^^^^^^^
@ -38,7 +38,7 @@ Returns the Content-Length header of *<url>*. Only HTTP urls are valid,
of course.
.. command-title:
.. _command-title:
title <url>
^^^^^^^^^^^
@ -46,7 +46,7 @@ title <url>
Returns the HTML *<title>*...*</title>* of a URL.
.. command-doctype:
.. _command-doctype:
doctype <url>
^^^^^^^^^^^^^
@ -55,7 +55,7 @@ Returns the DOCTYPE string of *<url>*. Only HTTP urls are valid, of
course.
.. command-headers:
.. _command-headers:
headers <url>
^^^^^^^^^^^^^
@ -64,7 +64,7 @@ Returns the HTTP headers of *<url>*. Only HTTP urls are valid, of
course.
.. command-fetch:
.. _command-fetch:
fetch <url>
^^^^^^^^^^^