diff --git a/generate_plugin_doc.py b/generate_plugin_doc.py new file mode 100644 index 0000000..b928231 --- /dev/null +++ b/generate_plugin_doc.py @@ -0,0 +1,73 @@ +#!/usr/bin/env python2 + +from __future__ import with_statement + +import os +import re +import sys + +# Commands instances are converted into SynchronizedAndFirewalled +from supybot.callbacks import SynchronizedAndFirewalled as Commands + +validCommandName = re.compile('^[a-z]+$') + +def main(): + pluginNames = sys.argv[1:] + for pluginName in pluginNames: + supybot = __import__('supybot.plugins.%s.plugin' % pluginName) + PluginClass = getattr(supybot.plugins, pluginName).plugin.Class + filename = 'use/plugins/%s.rst' % pluginName.lower() + os.unlink(filename) + with open(filename, 'a') as fd: + fd.write('\n.. _plugin-%s:\n\nThe %s plugin\n' % + (pluginName.lower(), pluginName)) + fd.write('='*len('The %s plugin' % pluginName)) + fd.write('\n\n') + writeDoc(PluginClass, fd, '') + +def writeDoc(PluginClass, fd, prefix): + if prefix != '': + prefix += ' ' + for attributeName, attribute in PluginClass.__dict__.items(): + if not callable(attribute): + continue + if not validCommandName.match(attributeName): + continue + if isinstance(attribute, Commands): + writeDoc(attribute, fd, prefix + attributeName) + else: + if attribute.__doc__ is None: + attribute.__doc__ = '' + syntax = attribute.__doc__.split('\n\n')[0].strip() + if syntax == 'takes no arguments': + syntax = '' + else: + syntax = ' ' + syntax + args = { + 'prefix_dash': prefix.replace(' ', '-'), + 'command': attributeName, # Does not contain spaces + 'prefix_with_trailing_space': prefix, + 'syntax': syntax, + 'help_string': parseHelpString(attribute.__doc__), + } + args['decoration'] = '^'*len('%(prefix_with_trailing_space)s%(command)s%(syntax)s' % + args) + 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) + +def parseHelpString(string): + # Remove the syntax + string = '\n\n'.join(string.split('\n\n')[1:]) + # Remove the starting and ending spaces + string = '\n'.join([x.strip(' ') for x in string.split('\n')]) + # Put the argument names into italic + string = re.sub(r'(<[^>]+>)', r'*\1*', string, re.M) + string = re.sub(r'(--[^ ]+)', r'*\1*', string, re.M) + return string + + +if __name__ == '__main__': + main() + diff --git a/use/index.rst b/use/index.rst index 2f63d70..b70cdbe 100644 --- a/use/index.rst +++ b/use/index.rst @@ -9,3 +9,4 @@ The Supybot user guide install.rst getting_started.rst + plugins/index.rst diff --git a/use/install.rst b/use/install.rst index c9018ea..0128787 100644 --- a/use/install.rst +++ b/use/install.rst @@ -151,6 +151,8 @@ http://python.org, and follow the rest of the steps. Installation: Windows ===================== +.. highlight:: bat + Install Python -------------- @@ -174,15 +176,11 @@ Once you have the code archive, extract it to some temporary directory, then open up a command prompt (Programs -> Run -> ``cmd``) and ``cd`` into the ``supybot`` directory which contains the extracted code. For example, if you have extracted the archive to ``C:\sometempdir\``, you would enter in the -prompt: - -.. code-block:: bat +prompt:: cd "C:\sometempdir\supybot" -Once there, run the installer to install, with the following command: - -.. code-block:: bat +Once there, run the installer to install, with the following command:: C:\Python27\python.exe setup.py install @@ -229,8 +227,6 @@ Now to start the bot, run, still from within the ``C:\runbot`` directory:: And watch the magic! -For a tutorial on using and managing the bot from here on, see the `Supybook`_. - This guide has been mainly written by nanotube (Daniel Folkinshteyn), and is licensed under the Creative Commons Attribution ShareAlike 3.0 Unported license and/or the GNU Free Documentation License v 1.3 or later. diff --git a/use/plugins/admin.rst b/use/plugins/admin.rst new file mode 100644 index 0000000..4cec201 --- /dev/null +++ b/use/plugins/admin.rst @@ -0,0 +1,90 @@ + +.. _plugin-admin: + +The Admin plugin +================ + +.. command-channels: + +channels +^^^^^^^^ + +Returns the channels the bot is on. Must be given in private, in order +to protect the secrecy of secret channels. + + +.. command-part: + +part [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Tells the bot to part the list of channels you give it. ** is +only necessary if you want the bot to part a channel other than the +current channel. If ** is specified, use it as the part +message. + + +.. command-ignore-list: + +ignore list +^^^^^^^^^^^ + +Lists the hostmasks that the bot is ignoring. + + +.. command-ignore-remove: + +ignore remove +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This will remove the persistent ignore on ** or the +hostmask currently associated with **. + + +.. command-ignore-add: + +ignore add [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This will set a persistent ignore on ** or the hostmask +currently associated with **. ** is an optional argument +specifying when (in "seconds from now") the ignore will expire; if +it isn't given, the ignore will never automatically expire. + + +.. command-join: + +join [] +^^^^^^^^^^^^^^^^^^^^^^ + +Tell the bot to join the given channel. If ** is given, it is used +when attempting to join the channel. + + +.. command-capability-add: + +capability add +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Gives the user specified by ** (or the user to whom ** +currently maps) the specified capability ** + + +.. command-capability-remove: + +capability remove +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Takes from the user specified by ** (or the user to whom +** currently maps) the specified capability ** + + +.. command-nick: + +nick [] +^^^^^^^^^^^^^ + +Changes the bot's nick to **. If no nick is given, returns the +bot's current nick. + + diff --git a/use/plugins/alias.rst b/use/plugins/alias.rst new file mode 100644 index 0000000..583350f --- /dev/null +++ b/use/plugins/alias.rst @@ -0,0 +1,43 @@ + +.. _plugin-alias: + +The Alias plugin +================ + +.. command-lock: + +lock +^^^^^^^^^^^^ + +Locks an alias so that no one else can change it. + + +.. command-unlock: + +unlock +^^^^^^^^^^^^^^ + +Unlocks an alias so that people can define new aliases over it. + + +.. command-remove: + +remove +^^^^^^^^^^^^^ + +Removes the given alias, if unlocked. + + +.. command-add: + +add +^^^^^^^^^^^^^^^^^^ + +Defines an alias ** that executes **. The ** +should be in the standard "command argument [nestedcommand argument]" +arguments to the alias; they'll be filled with the first, second, etc. +arguments. $1, $2, etc. can be used for required arguments. @1, @2, +etc. can be used for optional arguments. $* simply means "all +remaining arguments," and cannot be combined with optional arguments. + + diff --git a/use/plugins/anonymous.rst b/use/plugins/anonymous.rst new file mode 100644 index 0000000..0e6b440 --- /dev/null +++ b/use/plugins/anonymous.rst @@ -0,0 +1,23 @@ + +.. _plugin-anonymous: + +The Anonymous plugin +==================== + +.. command-do: + +do +^^^^^^^^^^^^^^^^^^^^^ + +Performs ** in **. + + +.. command-say: + +say +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sends ** to **. Can only send to ** if +supybot.plugins.Anonymous.allowPrivateTarget is True. + + diff --git a/use/plugins/automode.rst b/use/plugins/automode.rst new file mode 100644 index 0000000..6844b18 --- /dev/null +++ b/use/plugins/automode.rst @@ -0,0 +1,6 @@ + +.. _plugin-automode: + +The AutoMode plugin +=================== + diff --git a/use/plugins/badwords.rst b/use/plugins/badwords.rst new file mode 100644 index 0000000..71fde2e --- /dev/null +++ b/use/plugins/badwords.rst @@ -0,0 +1,37 @@ + +.. _plugin-badwords: + +The BadWords plugin +=================== + +.. command-sub: + +sub +^^^^ + + + +.. command-list: + +list +^^^^ + +Returns the list of words being censored. + + +.. command-remove: + +remove [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Removes **s from the list of words being censored. + + +.. command-add: + +add [ ...] +^^^^^^^^^^^^^^^^^^^^^^^ + +Adds all **s to the list of words being censored. + + diff --git a/use/plugins/channel.rst b/use/plugins/channel.rst new file mode 100644 index 0000000..8b973c9 --- /dev/null +++ b/use/plugins/channel.rst @@ -0,0 +1,383 @@ + +.. _plugin-channel: + +The Channel plugin +================== + +.. command-unmoderate: + +unmoderate [] +^^^^^^^^^^^^^^^^^^^^^^ + +Sets -m on **, making it so everyone can +send messages to the channel. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-devoice: + +devoice [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will remove voice from all +the nicks given. If no nicks are given, removes voice from the person +sending the message. + + +.. command-lobotomy-list: + +lobotomy list +^^^^^^^^^^^^^ + +Returns the channels in which this bot is lobotomized. + + +.. command-lobotomy-remove: + +lobotomy remove [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will unlobotomize the +bot, making it respond to requests made in the channel again. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-lobotomy-add: + +lobotomy add [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will "lobotomize" the +bot, making it silent and unanswering to all requests made in the +channel. ** is only necessary if the message isn't sent in +the channel itself. + + +.. command-deop: + +deop [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will remove operator +privileges from all the nicks given. If no nicks are given, removes +operator privileges from the person sending the message. + + +.. command-nicks: + +nicks [] [--count] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the nicks in **. ** is only necessary if the +message isn't sent in the channel itself. Returns only the number of +nicks if *--count* option is provided. + + +.. command-limit: + +limit [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sets the channel limit to **. If ** is 0, or isn't given, +removes the channel limit. ** is only necessary if the message +isn't sent in the channel itself. + + +.. command-moderate: + +moderate [] +^^^^^^^^^^^^^^^^^^^^ + +Sets +m on **, making it so only ops and voiced users can +send messages to the channel. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-unban: + +unban [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Unbans ** on **. If ** is not given, unbans +any hostmask currently banned on ** that matches your current +hostmask. Especially useful for unbanning yourself when you get +unexpectedly (or accidentally) banned from the channel. ** is +only necessary if the message isn't sent in the channel itself. + + +.. command-kick: + +kick [] [, , ...] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Kicks **(s) from ** for **. If ** isn't given, +uses the nick of the person making the command as the reason. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-enable: + +enable [] [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will enable the ** +in ** if it has been disabled. If ** is provided, +** will be enabled only for that plugin. If only ** is +provided, all commands in the given plugin will be enabled. ** +is only necessary if the message isn't sent in the channel itself. + + +.. command-invite: + +invite [] +^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will invite ** +to join **. ** is only necessary if the message isn't +sent in the channel itself. + + +.. command-dehalfop: + +dehalfop [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will remove half-operator +privileges from all the nicks given. If no nicks are given, removes +half-operator privileges from the person sending the message. + + +.. command-alert: + +alert [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +Sends ** to all the users in ** who have the **,op +capability. + + +.. command-disable: + +disable [] [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will disable the ** +in **. If ** is provided, ** will be disabled only +for that plugin. If only ** is provided, all commands in the +given plugin will be disabled. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-key: + +key [] [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Sets the keyword in ** to **. If ** is not given, removes +the keyword requirement to join **. ** is only necessary +if the message isn't sent in the channel itself. + + +.. command-ignore-list: + +ignore list [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Lists the hostmasks that the bot is ignoring on the given channel. +** is only necessary if the message isn't sent in the +channel itself. + + +.. command-ignore-remove: + +ignore remove [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will remove the +persistent ignore on ** in the channel. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-ignore-add: + +ignore add [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will set a persistent +ignore on ** or the hostmask currently +associated with **. ** is an optional argument +specifying when (in "seconds from now") the ignore will expire; if +it isn't given, the ignore will never automatically expire. +** is only necessary if the message isn't sent in the +channel itself. + + +.. command-cycle: + +cycle [] +^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will cause the bot to +"cycle", or PART and then JOIN the channel. ** is only necessary +if the message isn't sent in the channel itself. + + +.. command-capability-set: + +capability set [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will add the channel +capability ** for all users in the channel. ** is +only necessary if the message isn't sent in the channel itself. + + +.. command-capability-setdefault: + +capability setdefault [] {True|False} +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will set the default +response to non-power-related (that is, not {op, halfop, voice} +capabilities to be the value you give. ** is only necessary +if the message isn't sent in the channel itself. + + +.. command-capability-list: + +capability list [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the capabilities present on the **. ** is +only necessary if the message isn't sent in the channel itself. + + +.. command-capability-remove: + +capability remove [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will take from the +user currently identified as ** (or the user to whom ** +maps) the capability ** in the channel. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-capability-add: + +capability add [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will give the user +** (or the user to whom ** maps) +the capability ** in the channel. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-capability-unset: + +capability unset [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will unset the channel +capability ** so each user's specific capability or the +channel default capability will take precedence. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-kban: + +kban [] [--{exact,nick,user,host}] [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will kickban ** for +as many seconds as you specify, or else (if you specify 0 seconds or +don't specify a number of seconds) it will ban the person indefinitely. +*--exact* bans only the exact hostmask; *--nick* bans just the nick; +*--user* bans just the user, and *--host* bans just the host. You can +combine these options as you choose. ** is a reason to give for +the kick. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-halfop: + +halfop [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,halfop capability, this will give all the +**s you provide halfops. If you don't provide any **s, this +will give you halfops. ** is only necessary if the message isn't +sent in the channel itself. + + +.. command-mode: + +mode [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sets the mode in ** to **, sending the arguments given. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-ban-list: + +ban list [] +^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will show you the +current persistent bans on #channel. + + +.. command-ban-remove: + +ban remove [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will remove the +persistent ban on **. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-ban-add: + +ban add [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will effect a +persistent ban from interacting with the bot on the given +** (or the current hostmask associated with **. Other +plugins may enforce this ban by actually banning users with +matching hostmasks when they join. ** is an optional +argument specifying when (in "seconds from now") the ban should +expire; if none is given, the ban will never automatically expire. +** is only necessary if the message isn't sent in the +channel itself. + + +.. command-voice: + +voice [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,voice capability, this will voice all the +**s you provide. If you don't provide any **s, this will +voice you. ** is only necessary if the message isn't sent in the +channel itself. + + +.. command-op: + +op [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will give all the **s +you provide ops. If you don't provide any **s, this will op you. +** is only necessary if the message isn't sent in the channel +itself. + + diff --git a/use/plugins/channellogger.rst b/use/plugins/channellogger.rst new file mode 100644 index 0000000..45d48ce --- /dev/null +++ b/use/plugins/channellogger.rst @@ -0,0 +1,34 @@ + +.. _plugin-channellogger: + +The ChannelLogger plugin +======================== + +.. command-timestamp: + +timestamp +^^^^^^^^^^ + + + +.. command-flush: + +flush +^^^^^^ + + + +.. command-reset: + +reset +^^^^^^ + + + +.. command-die: + +die +^^^^ + + + diff --git a/use/plugins/channelstats.rst b/use/plugins/channelstats.rst new file mode 100644 index 0000000..2af1384 --- /dev/null +++ b/use/plugins/channelstats.rst @@ -0,0 +1,44 @@ + +.. _plugin-channelstats: + +The ChannelStats plugin +======================= + +.. command-stats: + +stats [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the statistics for ** on **. ** is only +necessary if the message isn't sent on the channel itself. If ** +isn't given, it defaults to the user sending the command. + + +.. command-die: + +die +^^^^ + + + +.. command-rank: + +rank [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the ranking of users according to the given stat expression. +Valid variables in the stat expression include 'msgs', 'chars', +'words', 'smileys', 'frowns', 'actions', 'joins', 'parts', 'quits', +'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical +expression involving those variables is permitted. + + +.. command-channelstats: + +channelstats [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the statistics for **. ** is only necessary if +the message isn't sent on the channel itself. + + diff --git a/use/plugins/conditional.rst b/use/plugins/conditional.rst new file mode 100644 index 0000000..ee4afd1 --- /dev/null +++ b/use/plugins/conditional.rst @@ -0,0 +1,176 @@ + +.. _plugin-conditional: + +The Conditional plugin +====================== + +.. command-gt: + +gt + + Does a string comparison on and . + Returns true if is greater than . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-nlt: + +nlt + + Does a numeric comparison on and . + Returns true if is less than . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-nne: + +nne + + Does a numeric comparison on and . + Returns true if they are not equal. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-ge: + +ge + + Does a string comparison on and . + Returns true if is greater than or equal to . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-cor: + +cor [ ... ] + + Returns true if any one of conditions supplied evaluates to true. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-nle: + +nle + + Does a numeric comparison on and . + Returns true if is less than or equal to . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-ceq: + +ceq + + Does a string comparison on and . + Returns true if they are equal. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-nge: + +nge + + Does a numeric comparison on and . + Returns true if is greater than or equal to . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-cxor: + +cxor [ ... ] + + Returns true if only one of conditions supplied evaluates to true. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-le: + +le + + Does a string comparison on and . + Returns true if is less than or equal to . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-cif: + +cif + + Runs if evaluates to true, runs + if it evaluates to false. + + Use other logical operators defined in this plugin and command nesting + to your advantage here. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-ne: + +ne + + Does a string comparison on and . + Returns true if they are not equal. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-cand: + +cand [ ... ] + + Returns true if all conditions supplied evaluate to true. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-nceq: + +nceq + + Does a numeric comparison on and . + Returns true if they are equal. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-ngt: + +ngt + + Does a numeric comparison on and . + Returns true if they is greater than . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-lt: + +lt + + Does a string comparison on and . + Returns true if is less than . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +.. command-match: + +match + + Determines if is a substring of . + Returns true if is contained in . +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + diff --git a/use/plugins/config.rst b/use/plugins/config.rst new file mode 100644 index 0000000..f233bc2 --- /dev/null +++ b/use/plugins/config.rst @@ -0,0 +1,83 @@ + +.. _plugin-config: + +The Config plugin +================= + +.. command-help: + +help +^^^^^^^^^^^ + +Returns the description of the configuration variable **. + + +.. command-default: + +default +^^^^^^^^^^^^^^ + +Returns the default value of the configuration variable **. + + +.. command-list: + +list +^^^^^^^^^^^^ + +Returns the configuration variables available under the given +configuration **. If a variable has values under it, it is +preceded by an '@' sign. If a variable is a 'ChannelValue', that is, +it can be separately configured for each channel using the 'channel' +command in this plugin, it is preceded by an '#' sign. + + +.. command-search: + +search +^^^^^^^^^^^^^ + +Searches for ** in the current configuration variables. + + +.. command-reload: + +reload +^^^^^^ + +Reloads the various configuration files (user database, channel +database, registry, etc.). + + +.. command-export: + +export +^^^^^^^^^^^^^^^^^ + +Exports the public variables of your configuration to **. +If you want to show someone your configuration file, but you don't +want that person to be able to see things like passwords, etc., this +command will export a "sanitized" configuration file suitable for +showing publicly. + + +.. command-channel: + +channel [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If ** is given, sets the channel configuration variable for ** +to ** for **. Otherwise, returns the current channel +configuration value of **. ** is only necessary if the +message isn't sent in the channel itself. + +.. command-config: + +config [] +^^^^^^^^^^^^^^^^^^^^^^^ + +If ** is given, sets the value of ** to **. Otherwise, +returns the current value of **. You may omit the leading +"supybot." in the name if you so choose. + + diff --git a/use/plugins/ctcp.rst b/use/plugins/ctcp.rst new file mode 100644 index 0000000..aeb379f --- /dev/null +++ b/use/plugins/ctcp.rst @@ -0,0 +1,18 @@ + +.. _plugin-ctcp: + +The Ctcp plugin +=============== + +.. command-version: + +version [] [--nicks] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sends a CTCP VERSION to **, returning the various +version strings returned. It waits for 10 seconds before returning +the versions received at that point. If *--nicks* is given, nicks are +associated with the version strings; otherwise, only the version +strings are given. + + diff --git a/use/plugins/dict.rst b/use/plugins/dict.rst new file mode 100644 index 0000000..a74a00e --- /dev/null +++ b/use/plugins/dict.rst @@ -0,0 +1,43 @@ + +.. _plugin-dict: + +The Dict plugin +=============== + +.. command-synonym: + +synonym [ ...] + 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 [] +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Looks up the definition of ** on the dictd server specified by +the supybot.plugins.Dict.server config variable. + + +.. command-random: + +random +^^^^^^ + +Returns a random valid dictionary. + + +.. command-dictionaries: + +dictionaries +^^^^^^^^^^^^ + +Returns the dictionaries valid for the dict command. + + diff --git a/use/plugins/dunno.rst b/use/plugins/dunno.rst new file mode 100644 index 0000000..f8d9d0f --- /dev/null +++ b/use/plugins/dunno.rst @@ -0,0 +1,6 @@ + +.. _plugin-dunno: + +The Dunno plugin +================ + diff --git a/use/plugins/factoids.rst b/use/plugins/factoids.rst new file mode 100644 index 0000000..6d2fdb5 --- /dev/null +++ b/use/plugins/factoids.rst @@ -0,0 +1,132 @@ + +.. _plugin-factoids: + +The Factoids plugin +=================== + +.. command-info: + +info [] +^^^^^^^^^^^^^^^^^^^^^^ + +Gives information about the factoid(s) associated with **. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-learn: + +learn +^^^^^^ + + + +.. command-forget: + +forget [] [|*] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Removes a key-fact relationship for key ** from the factoids +database. If there is more than one such relationship for this key, +a number is necessary to determine which one should be removed. +A * can be used to remove all relationships for **. + +If as a result, the key (factoid) remains without any relationships to +a factoid (key), it shall be removed from the database. + +** is only necessary if +the message isn't sent in the channel itself. + + +.. command-random: + +random [] +^^^^^^^^^^^^^^^^^^ + +Returns a random factoid from the database for **. ** +is only necessary if the message isn't sent in the channel itself. + + +.. command-rank: + +rank [] [--plain] [--alpha] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns a list of top-ranked factoid keys, sorted by usage count +(rank). If ** is not provided, the default number of factoid keys +returned is set by the rankListLength registry value. + +If *--plain* option is given, rank numbers and usage counts are not +included in output. + +If *--alpha* option is given in addition to *--plain,* keys are sorted +alphabetically, instead of by rank. + +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-unlock: + +unlock [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +Unlocks the factoid(s) associated with ** so that they can be +removed or added to. ** is only necessary if the message isn't +sent in the channel itself. + + +.. command-search: + +search [] [--values] [--{regexp} ] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Searches the keyspace for keys matching **. 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-whatis: + +whatis [] [--raw] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Looks up the value of ** in the factoid database. If given a +number, will return only that exact factoid. If '*--raw'* option is +given, no variable substitution will take place on the factoid. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-alias: + +alias [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Adds a new key ** for factoid associated with **. +** is only necessary if there's more than one factoid associated +with **. + +The same action can be accomplished by using the 'learn' function with +a new key but an existing (verbatim) factoid content. + + +.. command-change: + +change [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Changes the factoid #** associated with ** according to +**. + + +.. command-lock: + +lock [] +^^^^^^^^^^^^^^^^^^^^^^ + +Locks the factoid(s) associated with ** so that they cannot be +removed or added to. ** is only necessary if the message isn't +sent in the channel itself. + + diff --git a/use/plugins/filter.rst b/use/plugins/filter.rst new file mode 100644 index 0000000..534e6e9 --- /dev/null +++ b/use/plugins/filter.rst @@ -0,0 +1,209 @@ + +.. _plugin-filter: + +The Filter plugin +================= + +.. command-undup: + +undup +^^^^^^^^^^^^ + +Returns **, with all consecutive duplicated letters removed. + + +.. command-unhexlify: + +unhexlify +^^^^^^^^^^^^^^^^^^^^^ + +Returns the string corresponding to **. Obviously, +** must be a string of hexadecimal digits. + + +.. command-stripcolor: + +stripcolor +^^^^^^^^^^^^^^^^^ + +Returns ** stripped of all color codes. + + +.. command-unbinary: + +unbinary +^^^^^^^^^^^^^^^ + +Returns the character representation of binary **. +Assumes ASCII, 8 digits per character. + + +.. command-hebrew: + +hebrew +^^^^^^^^^^^^^ + +Removes all the vowels from **. (If you're curious why this is +named 'hebrew' it's because I (jemfinch) thought of it in Hebrew class, +and printed Hebrew often elides the vowels.) + + +.. command-colorize: + +colorize +^^^^^^^^^^^^^^^ + +Returns ** with each character randomly colorized. + + +.. command-binary: + +binary +^^^^^^^^^^^^^ + +Returns the binary representation of **. + + +.. command-leet: + +leet +^^^^^^^^^^^ + +Returns the l33tspeak version of ** + + +.. command-lithp: + +lithp +^^^^^^^^^^^^ + +Returns the lisping version of ** + + +.. command-morse: + +morse +^^^^^^^^^^^^ + +Gives the Morse code equivalent of a given string. + + +.. command-outfilter: + +outfilter [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sets the outFilter of this plugin to be **. If no command is +given, unsets the outFilter. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-spellit: + +spellit +^^^^^^^^^^^^^^ + +Returns **, phonetically spelled out. + + +.. command-rainbow: + +rainbow +^^^^^^^^^^^^^^ + +Returns ** colorized like a rainbow. + + +.. command-aol: + +aol +^^^^^^^^^^ + +Returns ** as if an AOLuser had said it. + + +.. command-hexlify: + +hexlify +^^^^^^^^^^^^^^ + +Returns a hexstring from the given string; a hexstring is a string +composed of the hexadecimal value of each character in the string + + +.. command-unmorse: + +unmorse +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Does the reverse of the morse command. + + +.. command-squish: + +squish +^^^^^^^^^^^^^ + +Removes all the spaces from **. + + +.. command-reverse: + +reverse +^^^^^^^^^^^^^^ + +Reverses **. + + +.. command-azn: + +azn +^^^^^^^^^^ + +Returns ** with the l's made into r's and r's made into l's. + + +.. command-gnu: + +gnu +^^^^^^^^^^ + +Returns ** as GNU/RMS would say it. + + +.. command-jeffk: + +jeffk +^^^^^^^^^^^^ + +Returns ** as if JeffK had said it himself. + + +.. command-shrink: + +shrink +^^^^^^^^^^^^^ + +Returns ** with each word longer than +supybot.plugins.Filter.shrink.minimum being shrunken (i.e., like +"internationalization" becomes "i18n"). + + +.. command-uniud: + +uniud +^^^^^^^^^^^^ + +Returns ** rotated 180 degrees. Only really works for ASCII +printable characters. + + +.. command-scramble: + +scramble +^^^^^^^^^^^^^^^ + +Replies with a string where each word is scrambled; i.e., each internal +letter (that is, all letters but the first and last) are shuffled. + + diff --git a/use/plugins/format.rst b/use/plugins/format.rst new file mode 100644 index 0000000..d722388 --- /dev/null +++ b/use/plugins/format.rst @@ -0,0 +1,145 @@ + +.. _plugin-format: + +The Format plugin +================= + +.. command-upper: + +upper +^^^^^^^^^^^^ + +Returns ** uppercased. + + +.. command-bold: + +bold +^^^^^^^^^^^ + +Returns ** bolded. + + +.. command-format: + +format [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Expands a Python-style format string using the remaining args. Just be +sure always to use %s, not %d or %f or whatever, because all the args +are strings. + + +.. command-color: + +color [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns ** with foreground color ** and background color +** (if given) + + +.. command-repr: + +repr +^^^^^^^^^^^ + +Returns the text surrounded by double quotes. + + +.. command-replace: + +replace +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Replaces all non-overlapping occurrences of ** +with ** in **. + + +.. command-capitalize: + +capitalize +^^^^^^^^^^^^^^^^^ + +Returns ** capitalized. + + +.. command-underline: + +underline +^^^^^^^^^^^^^^^^ + +Returns ** underlined. + + +.. command-lower: + +lower +^^^^^^^^^^^^ + +Returns ** lowercased. + + +.. command-cut: + +cut +^^^^^^^^^^^^^^^^^ + +Cuts ** down to ** by chopping off the rightmost characters in +excess of **. If ** is a negative number, it chops that many +characters off the end of **. + + +.. command-join: + +join [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Joins all the arguments together with **. + + +.. command-reverse: + +reverse +^^^^^^^^^^^^^^ + +Returns ** in reverse-video. + + +.. command-title: + +title +^^^^^^^^^^^^ + +Returns ** titlecased. + + +.. command-field: + +field +^^^^^^^^^^^^^^^^^^^^^ + +Returns the **th space-separated field of **. I.e., if text +is "foo bar baz" and ** is 2, "bar" is returned. + + +.. command-concat: + +concat +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Concatenates two strings. Do keep in mind that this is *not* the same +thing as join "", since if ** contains spaces, they won't be +removed by concat. + + +.. command-translate: + +translate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Replaces ** with ** in +**. The first and second arguments must necessarily be the same +length. + + diff --git a/use/plugins/games.rst b/use/plugins/games.rst new file mode 100644 index 0000000..cc7baf7 --- /dev/null +++ b/use/plugins/games.rst @@ -0,0 +1,52 @@ + +.. _plugin-games: + +The Games plugin +================ + +.. command-dice: + +dice d +^^^^^^^^^^^^^^^^^^^ + +Rolls a die with ** number of sides ** times. +For example, 2d6 will roll 2 six-sided dice; 10d10 will roll 10 +ten-sided dice. + + +.. command-roulette: + +roulette [spin] +^^^^^^^^^^^^^^^ + +Fires the revolver. If the bullet was in the chamber, you're dead. +Tell me to spin the chambers and I will. + + +.. command-eightball: + +eightball [] +^^^^^^^^^^^^^^^^^^^^^^ + +Ask a question and the answer shall be provided. + + +.. command-monologue: + +monologue [] +^^^^^^^^^^^^^^^^^^^^^ + +Returns the number of consecutive lines you've sent in ** +without being interrupted by someone else (i.e. how long your current +'monologue' is). ** is only necessary if the message isn't sent +in the channel itself. + + +.. command-coin: + +coin +^^^^ + +Flips a coin and returns the result. + + diff --git a/use/plugins/google.rst b/use/plugins/google.rst new file mode 100644 index 0000000..6816098 --- /dev/null +++ b/use/plugins/google.rst @@ -0,0 +1,81 @@ + +.. _plugin-google: + +The Google plugin +================= + +.. command-google: + +google [--{filter,language} ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Searches google.com for the given string. As many results as can fit +are included. *--language* accepts a language abbreviation; *--filter +accepts* a filtering level ('active', 'moderate', 'off'). + + +.. command-search: + +search Perform a search using Google's AJAX API. + search("search phrase", options={}) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Valid options are: +smallsearch - True/False (Default: False) +filter - {active,moderate,off} (Default: "moderate") +language - Restrict search to documents in the given language +(Default: "lang_en") + + +.. command-cache: + +cache +^^^^^^^^^^^ + +Returns a link to the cached version of ** if it is available. + + +.. command-lucky: + +lucky [--snippet] +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Does a google search, but only returns the first result. +If option *--snippet* is given, returns also the page text snippet. + + +.. command-fight: + +fight [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the results of each search, in order, from greatest number +of results to least. + + +.. command-phonebook: + +phonebook +^^^^^^^^^^^^^^^^^^^^^^^^ + +Looks ** up on Google. + + +.. command-calc: + +calc +^^^^^^^^^^^^^^^^^ + +Uses Google's calculator to calculate the value of **. + + +.. command-translate: + +translate [to] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns ** translated from ** into **. +Beware that translating to or from languages that use multi-byte +characters may result in some very odd results. + + diff --git a/use/plugins/herald.rst b/use/plugins/herald.rst new file mode 100644 index 0000000..f6ad804 --- /dev/null +++ b/use/plugins/herald.rst @@ -0,0 +1,68 @@ + +.. _plugin-herald: + +The Herald plugin +================= + +.. command-get: + +get [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the current herald message for ** (or the user +** is currently identified or recognized as). If ** +is not given, defaults to the user giving the command. ** +is only necessary if the message isn't sent in the channel itself. + + +.. command-die: + +die +^^^^ + + + +.. command-remove: + +remove [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Removes the herald message set for **, or the user +** is currently identified or recognized as. If ** +is not given, defaults to the user giving the command. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-default: + +default [] [--remove|] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If ** is given, sets the default herald to **. A ** of "" +will remove the default herald. If ** is not given, returns the +current default herald. ** is only necessary if the message +isn't sent in the channel itself. + + +.. command-add: + +add [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sets the herald message for ** (or the user ** is +currently identified or recognized as) to **. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-change: + +change [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Changes the herald message for **, or the user ** is +currently identified or recognized as, according to **. If +** is not given, defaults to the calling user. ** is only +necessary if the message isn't sent in the channel itself. + + diff --git a/use/plugins/index.rst b/use/plugins/index.rst new file mode 100644 index 0000000..190d245 --- /dev/null +++ b/use/plugins/index.rst @@ -0,0 +1,14 @@ +.. _main-plugins: + +*************** +Supybot plugins +*************** + +Main plugins +============ + +.. toctree:: + :maxdepth: 3 + + owner.rst + admin.rst diff --git a/use/plugins/internet.rst b/use/plugins/internet.rst new file mode 100644 index 0000000..dc7b379 --- /dev/null +++ b/use/plugins/internet.rst @@ -0,0 +1,30 @@ + +.. _plugin-internet: + +The Internet plugin +=================== + +.. command-whois: + +whois +^^^^^^^^^^^^^^ + +Returns WHOIS information on the registration of **. + + +.. command-dns: + +dns +^^^^^^^^^^^^^ + +Returns the ip of ** or the reverse DNS hostname of **. + + +.. command-hexip: + +hexip +^^^^^^^^^^ + +Returns the hexadecimal IP for that IP. + + diff --git a/use/plugins/karma.rst b/use/plugins/karma.rst new file mode 100644 index 0000000..827b67d --- /dev/null +++ b/use/plugins/karma.rst @@ -0,0 +1,64 @@ + +.. _plugin-karma: + +The Karma plugin +================ + +.. command-load: + +load [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Loads the Karma database for ** from ** in the bot's +data directory. ** is only necessary if the message isn't sent +in the channel itself. + + +.. command-dump: + +dump [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Dumps the Karma database for ** to ** in the bot's +data directory. ** is only necessary if the message isn't sent +in the channel itself. + + +.. command-die: + +die +^^^^ + + + +.. command-clear: + +clear [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +Resets the karma of ** to 0. + + +.. command-most: + +most [] {increased,decreased,active} +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the most increased, the most decreased, or the most active +(the sum of increased and decreased) karma things. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-karma: + +karma [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the karma of **. If ** is not given, returns the top +N karmas, where N is determined by the config variable +supybot.plugins.Karma.rankingDisplay. If one ** is given, returns +the details of its karma; if more than one ** is given, returns +the total karma of each of the the things. ** is only necessary +if the message isn't sent on the channel itself. + + diff --git a/use/plugins/lart.rst b/use/plugins/lart.rst new file mode 100644 index 0000000..4285f7f --- /dev/null +++ b/use/plugins/lart.rst @@ -0,0 +1,16 @@ + +.. _plugin-lart: + +The Lart plugin +=============== + +.. command-lart: + +lart [] [] [for ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Uses the Luser Attitude Readjustment Tool on ** (for **, +if given). If ** is given, uses that specific lart. ** is +only necessary if the message isn't sent in the channel itself. + + diff --git a/use/plugins/later.rst b/use/plugins/later.rst new file mode 100644 index 0000000..38db627 --- /dev/null +++ b/use/plugins/later.rst @@ -0,0 +1,40 @@ + +.. _plugin-later: + +The Later plugin +================ + +.. command-die: + +die +^^^^ + + + +.. command-notes: + +notes [] +^^^^^^^^^^^^^^ + +If ** is given, replies with what notes are waiting on **, +otherwise, replies with the nicks that have notes waiting for them. + + +.. command-remove: + +remove +^^^^^^^^^^^^^ + +Removes the notes waiting on **. + + +.. command-tell: + +tell +^^^^^^^^^^^^^^^^^^ + +Tells ** ** the next time ** is in seen. ** can +contain wildcard characters, and the first matching nick will be +given the note. + + diff --git a/use/plugins/limiter.rst b/use/plugins/limiter.rst new file mode 100644 index 0000000..7ace54f --- /dev/null +++ b/use/plugins/limiter.rst @@ -0,0 +1,6 @@ + +.. _plugin-limiter: + +The Limiter plugin +================== + diff --git a/use/plugins/math.rst b/use/plugins/math.rst new file mode 100644 index 0000000..9117612 --- /dev/null +++ b/use/plugins/math.rst @@ -0,0 +1,64 @@ + +.. _plugin-math: + +The Math plugin +=============== + +.. command-base: + +base [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Converts ** from base ** to base **. +If ** is left out, it converts to decimal. + + +.. command-rpn: + +rpn +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the value of an RPN expression. + + +.. command-convert: + +convert [] to +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Converts from ** to **. If number isn't given, it +defaults to 1. For unit information, see 'units' command. + + +.. command-icalc: + +icalc +^^^^^^^^^^^^^^^^^^^^^^^ + +This is the same as the calc command except that it allows integer +math, and can thus cause the bot to suck up CPU. Hence it requires +the 'trusted' capability to use. + + +.. command-units: + +units [] +^^^^^^^^^^^^^^ + +With no arguments, returns a list of measurement types, which can be +passed as arguments. When called with a type as an argument, returns +the units of that type. + + +.. command-calc: + +calc +^^^^^^^^^^^^^^^^^^^^^^ + +Returns the value of the evaluated **. The syntax is +Python syntax; the type of arithmetic is floating point. Floating +point arithmetic is used in order to prevent a user from being able to +crash to the bot with something like '10**10**10**10'. One consequence +is that large values such as '10**24' might not be exact. + + diff --git a/use/plugins/messageparser.rst b/use/plugins/messageparser.rst new file mode 100644 index 0000000..793c8ff --- /dev/null +++ b/use/plugins/messageparser.rst @@ -0,0 +1,103 @@ + +.. _plugin-messageparser: + +The MessageParser plugin +======================== + +.. command-show: + +show [] [--id] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Looks up the value of ** in the triggers database. +** is only necessary if the message isn't sent in the channel +itself. +If option *--id* specified, will retrieve by regexp id, not content. + + +.. command-lock: + +lock [] +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Locks the ** so that it cannot be +removed or overwritten to. ** is only necessary if the message isn't +sent in the channel itself. + + +.. command-rank: + +rank [] +^^^^^^^^^^^^^^^^ + +Returns a list of top-ranked regexps, sorted by usage count +(rank). The number of regexps returned is set by the +rankListLength registry value. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-unlock: + +unlock [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Unlocks the entry associated with ** so that it can be +removed or overwritten. ** is only necessary if the message isn't +sent in the channel itself. + + +.. command-vacuum: + +vacuum [] +^^^^^^^^^^^^^^^^^^ + +Vacuums the database for **. +See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html +** is only necessary if the message isn't sent in +the channel itself. +First check if user has the required capability specified in plugin +config requireVacuumCapability. + + +.. command-info: + +info [] [--id] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Display information about ** in the triggers database. +** is only necessary if the message isn't sent in the channel +itself. +If option *--id* specified, will retrieve by regexp id, not content. + + +.. command-list: + +list [] +^^^^^^^^^^^^^^^^ + +Lists regexps present in the triggers database. +** is only necessary if the message isn't sent in the channel +itself. Regexp ID listed in paretheses. + + +.. command-remove: + +remove [] [--id] ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Removes the trigger for ** from the triggers database. +** is only necessary if +the message isn't sent in the channel itself. +If option *--id* specified, will retrieve by regexp id, not content. + + +.. command-add: + +add [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Associates ** with **. ** is only +necessary if the message isn't sent on the channel +itself. Action is echoed upon regexp match, with variables $1, $2, +etc. being interpolated from the regexp match groups. + diff --git a/use/plugins/misc.rst b/use/plugins/misc.rst new file mode 100644 index 0000000..66abe22 --- /dev/null +++ b/use/plugins/misc.rst @@ -0,0 +1,92 @@ + +.. _plugin-misc: + +The Misc plugin +=============== + +.. command-last: + +last [--{from,in,on,with,without,regexp} ] [--nolimit] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the last message matching the given criteria. *--from* requires +a nick from whom the message came; *--in* requires a channel the message +was sent to; *--on* requires a network the message was sent on; *--with +requires* some string that had to be in the message; *--regexp* requires +a regular expression the message must match; *--nolimit* returns all +the messages that can be found. By default, the channel this command is +given in is searched. + + +.. command-help: + +help [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This command gives a useful description of what ** does. +** is only necessary if the command is in more than one plugin. + + +.. command-list: + +list [--private] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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-ping: + +ping +^^^^ + +Checks to see if the bot is alive. + + +.. command-source: + +source +^^^^^^ + +Returns a URL saying where to get Supybot. + + +.. command-version: + +version +^^^^^^^ + +Returns the version of the current bot. + + +.. command-apropos: + +apropos +^^^^^^^^^^^^^^^^ + +Searches for ** in the commands currently offered by the bot, +returning a list of the commands containing that string. + + +.. command-tell: + +tell +^^^^^^^^^^^^^^^^^^ + +Tells the ** whatever ** is. Use nested commands to your +benefit here. + + +.. command-more: + +more [] +^^^^^^^^^^^^^ + +If the last command was truncated due to IRC message length +limitations, returns the next chunk of the result of the last command. +If ** is given, it takes the continuation of the last command from +** instead of the person sending this message. + + diff --git a/use/plugins/moobotfactoids.rst b/use/plugins/moobotfactoids.rst new file mode 100644 index 0000000..2440ba4 --- /dev/null +++ b/use/plugins/moobotfactoids.rst @@ -0,0 +1,122 @@ + +.. _plugin-moobotfactoids: + +The MoobotFactoids plugin +========================= + +.. command-lock: + +lock [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Locks the factoid with the given factoid key. Requires that the user +be registered and have created the factoid originally. ** is +only necessary if the message isn't sent in the channel itself. + + +.. command-listauth: + +listauth [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Lists the keys of the factoids with the given author. Note that if an +author has an integer name, you'll have to use that author's id to use +this function (so don't use integer usernames!). ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-random: + +random [] +^^^^^^^^^^^^^^^^^^ + +Displays a random factoid (along with its key) from the database. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-unlock: + +unlock [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Unlocks the factoid with the given factoid key. Requires that the +user be registered and have locked the factoid. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-literal: + +literal [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the literal factoid for the given factoid key. No parsing of +the factoid value is done as it is with normal retrieval. ** +is only necessary if the message isn't sent in the channel itself. + + +.. command-listvalues: + +listvalues [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Lists the keys of the factoids whose value contains the provided text. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-reset: + +reset +^^^^^^ + + + +.. command-factinfo: + +factinfo [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the various bits of info on the factoid for the given key. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-most: + +most [] {popular|authored|recent} +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Lists the most {popular|authored|recent} factoids. "popular" lists the +most frequently requested factoids. "authored" lists the author with +the most factoids. "recent" lists the most recently created factoids. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-die: + +die +^^^^ + + + +.. command-remove: + +remove [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Deletes the factoid with the given key. ** is only necessary +if the message isn't sent in the channel itself. + + +.. command-listkeys: + +listkeys [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Lists the keys of the factoids whose key contains the provided text. +** is only necessary if the message isn't sent in the channel +itself. + + diff --git a/use/plugins/network.rst b/use/plugins/network.rst new file mode 100644 index 0000000..0c85c44 --- /dev/null +++ b/use/plugins/network.rst @@ -0,0 +1,87 @@ + +.. _plugin-network: + +The Network plugin +================== + +.. command-driver: + +driver [] +^^^^^^^^^^^^^^^^^^ + +Returns the current network driver for **. ** is only +necessary if the message isn't sent on the network to which this +command is to apply. + + +.. command-connect: + +connect [--ssl] [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Connects to another network (which will be represented by the name +provided in **) at **. 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-reconnect: + +reconnect [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Disconnects and then reconnects to **. If no network is given, +disconnects and then reconnects to the network the command was given +on. If no quit message is given, uses the configured one +(supybot.plugins.Owner.quitMsg) or the nick of the person giving the +command. + + +.. command-networks: + +networks +^^^^^^^^ + +Returns the networks to which the bot is currently connected. + + +.. command-latency: + +latency [] +^^^^^^^^^^^^^^^^^^^ + +Returns the current latency to **. ** is only necessary +if the message isn't sent on the network to which this command is to +apply. + + +.. command-disconnect: + +disconnect [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Disconnects from the network represented by the network **. +If ** is given, quits the network with the given quit +message. ** is only necessary if the network is different +from the network the command is sent on. + + +.. command-whois: + +whois [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the WHOIS response ** gives for **. ** is +only necessary if the network is different than the network the command +is sent on. + + +.. command-command: + +command [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Gives the bot ** (with its associated **s) on **. + + diff --git a/use/plugins/news.rst b/use/plugins/news.rst new file mode 100644 index 0000000..67b7541 --- /dev/null +++ b/use/plugins/news.rst @@ -0,0 +1,65 @@ + +.. _plugin-news: + +The News plugin +=============== + +.. command-old: + +old [] [] +^^^^^^^^^^^^^^^^^^^^^^ + +Returns the old news item for ** with **. If no number is +given, returns all the old news items in reverse order. ** is +only necessary if the message isn't sent in the channel itself. + + +.. command-die: + +die +^^^^ + + + +.. command-remove: + +remove [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Removes the news item with ** from **. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-add: + +add [] : +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Adds a given news item of ** to a channel with the given **. +If ** isn't 0, that news item will expire ** seconds from +now. ** is only necessary if the message isn't sent in the +channel itself. + + +.. command-news: + +news [] [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Display the news items for ** in the format of '(#id) subject'. +If ** is given, retrieve only that news item; otherwise retrieve all +news items. ** is only necessary if the message isn't sent in +the channel itself. + + +.. command-change: + +change [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Changes the news item with ** from ** according to the +regular expression **. ** should be of the form +s/text/replacement/flags. ** is only necessary if the message +isn't sent on the channel itself. + + diff --git a/use/plugins/nickcapture.rst b/use/plugins/nickcapture.rst new file mode 100644 index 0000000..b0273dd --- /dev/null +++ b/use/plugins/nickcapture.rst @@ -0,0 +1,6 @@ + +.. _plugin-nickcapture: + +The NickCapture plugin +====================== + diff --git a/use/plugins/nickometer.rst b/use/plugins/nickometer.rst new file mode 100644 index 0000000..9617ca3 --- /dev/null +++ b/use/plugins/nickometer.rst @@ -0,0 +1,22 @@ + +.. _plugin-nickometer: + +The Nickometer plugin +===================== + +.. command-punish: + +punish +^^^^^^^ + + + +.. command-nickometer: + +nickometer [] +^^^^^^^^^^^^^^^^^^^ + +Tells you how lame said nick is. If ** is not given, uses the +nick of the person giving the command. + + diff --git a/use/plugins/note.rst b/use/plugins/note.rst new file mode 100644 index 0000000..6d6aed7 --- /dev/null +++ b/use/plugins/note.rst @@ -0,0 +1,77 @@ + +.. _plugin-note: + +The Note plugin +=============== + +.. command-unsend: + +unsend +^^^^^^^^^^^ + +Unsends the note with the id given. You must be the +author of the note, and it must be unread. + + +.. command-search: + +search [--{regexp} ] [--sent] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Searches your received notes for ones matching **. If *--regexp* is +given, its associated value is taken as a regexp and matched against +the notes. If *--sent* is specified, only search sent notes. + + +.. command-reply: + +reply +^^^^^^^^^^^^^^^^^ + +Sends a note in reply to **. + + +.. command-die: + +die +^^^^ + + + +.. command-list: + +list [--{old,sent}] [--{from,to} ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Retrieves the ids of all your unread notes. If *--old* is given, list +read notes. If *--sent* is given, list notes that you have sent. If +*--from* is specified, only lists notes sent to you from **. If +*--to* is specified, only lists notes sent by you to **. + + +.. command-send: + +send ,[,[...]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sends a new note to the user specified. Multiple recipients may be +specified by separating their names by commas. + + +.. command-next: + +next +^^^^ + +Retrieves your next unread note, if any. + + +.. command-note: + +note +^^^^^^^^^ + +Retrieves a single note by its unique note id. Use the 'note list' +command to see what unread notes you have. + + diff --git a/use/plugins/owner.rst b/use/plugins/owner.rst new file mode 100644 index 0000000..ace9f23 --- /dev/null +++ b/use/plugins/owner.rst @@ -0,0 +1,166 @@ + +.. _plugin-owner: + +The Owner plugin +================ + +.. command-load: + +load [--deprecated] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Loads the plugin ** from any of the directories in +conf.supybot.directories.plugins; usually this includes the main +installed directory and 'plugins' in the current directory. +*--deprecated* is necessary if you wish to load deprecated plugins. + + +.. command-rename: + +rename +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Renames ** in ** to the **. + + +.. command-enable: + +enable [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Enables the command ** for all users. If ** +if given, only enables the ** from **. This command is +the inverse of disable. + + +.. command-defaultcapability: + +defaultcapability {add|remove} +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Adds or removes (according to the first argument) ** from the +default capabilities given to users (the configuration variable +supybot.capabilities stores these). + + +.. command-reloadlocale: + +reloadlocale takes no argument +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Reloads the locale of the bot. + +.. command-ircquote: + +ircquote +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sends the raw string given to the server. + + +.. command-disable: + +disable [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Disables the command ** for all users (including the owners). +If ** is given, only disables the ** from **. If +you want to disable a command for most users but not for yourself, set +a default capability of -plugin.command or -command (if you want to +disable the command in all plugins). + + +.. command-upkeep: + +upkeep [] +^^^^^^^^^^^^^^^^ + +Runs the standard upkeep stuff (flushes and gc.collects()). If given +a level, runs that level of upkeep (currently, the only supported +level is "high", which causes the bot to flush a lot of caches as well +as do normal upkeep stuff. + + +.. command-flush: + +flush +^^^^^ + +Runs all the periodic flushers in world.flushers. This includes +flushing all logs and all configuration changes to disk. + + +.. command-unrename: + +unrename +^^^^^^^^^^^^^^^^^ + +Removes all renames in **. The plugin will be reloaded after +this command is run. + + +.. command-reset: + +reset +^^^^^^ + + + +.. command-quit: + +quit [] +^^^^^^^^^^^^^ + +Exits the bot with the QUIT message **. If ** is not given, +the default quit message (supybot.plugins.Owner.quitMsg) will be used. +If there is no default quitMsg set, your nick will be used. + + +.. command-unload: + +unload +^^^^^^^^^^^^^^^ + +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-reload: + +reload +^^^^^^^^^^^^^^^ + +Unloads and subsequently reloads the plugin by name; use the 'list' +command to see a list of the currently loaded plugins. + + +.. command-announce: + +announce +^^^^^^^^^^^^^^^ + +Sends ** to all channels the bot is currently on and not +lobotomized in. + + +.. command-defaultplugin: + +defaultplugin [--remove] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sets the default plugin for ** to **. If *--remove* is +given, removes the current default plugin for **. If no plugin +is given, returns the current default plugin set for **. See +also, supybot.commands.defaultPlugins.importantPlugins. + + +.. command-logmark: + +logmark +^^^^^^^^^^^^^^ + +Logs ** to the global Supybot log at critical priority. Useful for +marking logfiles for later searching. + + diff --git a/use/plugins/plugin.rst b/use/plugins/plugin.rst new file mode 100644 index 0000000..648bb2f --- /dev/null +++ b/use/plugins/plugin.rst @@ -0,0 +1,62 @@ + +.. _plugin-plugin: + +The Plugin plugin +================= + +.. command-help: + +help +^^^^^^^^^^^^^ + +Returns a useful description of how to use **, if the plugin has +one. + + +.. command-contributors: + +contributors [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Replies with a list of people who made contributions to a given plugin. +If ** is specified, that person's specific contributions will +be listed. Note: The ** is the part inside of the parentheses +in the people listing. + + +.. command-plugin: + +plugin +^^^^^^^^^^^^^^^^ + +Returns the name of the plugin that would be used to call **. + +If it is not uniquely determined, returns list of all plugins that +contain **. + + +.. command-author: + +author +^^^^^^^^^^^^^^^ + +Returns the author of **. This is the person you should talk to +if you have ideas, suggestions, or other comments about a given plugin. + + +.. command-list: + +list +^^^^ + +Returns a list of the currently loaded plugins. + + +.. command-plugins: + +plugins +^^^^^^^^^^^^^^^^^ + +Returns the names of all plugins that contain **. + + diff --git a/use/plugins/plugindownloader.rst b/use/plugins/plugindownloader.rst new file mode 100644 index 0000000..c393773 --- /dev/null +++ b/use/plugins/plugindownloader.rst @@ -0,0 +1,22 @@ + +.. _plugin-plugindownloader: + +The PluginDownloader plugin +=========================== + +.. command-install: + +install +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Downloads and installs the ** from the **. + +.. command-repolist: + +repolist [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Displays the list of plugins in the **. +If ** is not given, returns a list of available +repositories. + diff --git a/use/plugins/praise.rst b/use/plugins/praise.rst new file mode 100644 index 0000000..c576fd3 --- /dev/null +++ b/use/plugins/praise.rst @@ -0,0 +1,16 @@ + +.. _plugin-praise: + +The Praise plugin +================= + +.. command-praise: + +praise [] [] [for ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Praises ** (for **, if given). If ** is given, uses +that specific praise. ** is only necessary if the message isn't +sent in the channel itself. + + diff --git a/use/plugins/protector.rst b/use/plugins/protector.rst new file mode 100644 index 0000000..2afe60f --- /dev/null +++ b/use/plugins/protector.rst @@ -0,0 +1,13 @@ + +.. _plugin-protector: + +The Protector plugin +==================== + +.. command-demote: + +demote +^^^^^^^ + + + diff --git a/use/plugins/quote.rst b/use/plugins/quote.rst new file mode 100644 index 0000000..783083a --- /dev/null +++ b/use/plugins/quote.rst @@ -0,0 +1,15 @@ + +.. _plugin-quote: + +The Quote plugin +================ + +.. command-random: + +random [] +^^^^^^^^^^^^^^^^^^ + +Returns a random quote from **. ** is only necessary if +the message isn't sent in the channel itself. + + diff --git a/use/plugins/quotegrabs.rst b/use/plugins/quotegrabs.rst new file mode 100644 index 0000000..b6c2c94 --- /dev/null +++ b/use/plugins/quotegrabs.rst @@ -0,0 +1,74 @@ + +.. _plugin-quotegrabs: + +The QuoteGrabs plugin +===================== + +.. command-ungrab: + +ungrab [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Removes the grab ** (the last by default) on **. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-get: + +get [] +^^^^^^^^^^^^^^^^^^^^ + +Return the quotegrab with the given **. ** is only necessary +if the message isn't sent in the channel itself. + + +.. command-quote: + +quote [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns **'s latest quote grab in **. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-random: + +random [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns a randomly grabbed quote, optionally choosing only from those +quotes grabbed for **. ** is only necessary if the message +isn't sent in the channel itself. + + +.. command-list: + +list [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Returns a list of shortened quotes that have been grabbed for ** +as well as the id of each quote. These ids can be used to get the +full quote. ** is only necessary if the message isn't sent in +the channel itself. + + +.. command-search: + +search [] +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Searches for ** in a quote. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-grab: + +grab [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Grabs a quote from ** by ** for the quotegrabs table. +** is only necessary if the message isn't sent in the channel +itself. + + diff --git a/use/plugins/relay.rst b/use/plugins/relay.rst new file mode 100644 index 0000000..9ba9dbb --- /dev/null +++ b/use/plugins/relay.rst @@ -0,0 +1,39 @@ + +.. _plugin-relay: + +The Relay plugin +================ + +.. command-nicks: + +nicks [] +^^^^^^^^^^^^^^^^^ + +Returns the nicks of the people in the channel on the various networks +the bot is connected to. ** is only necessary if the message +isn't sent on the channel itself. + + +.. command-part: + +part +^^^^^^^^^^^^^^ + +Ceases relaying between the channel ** on all networks. The bot +will part from the channel on all networks in which it is on the +channel. + + +.. command-join: + +join [] +^^^^^^^^^^^^^^^^ + +Starts relaying between the channel ** on all networks. If on a +network the bot isn't in **, 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 ** is not given, starts relaying on the channel +the message was sent in. + + diff --git a/use/plugins/reply.rst b/use/plugins/reply.rst new file mode 100644 index 0000000..34f5d7b --- /dev/null +++ b/use/plugins/reply.rst @@ -0,0 +1,50 @@ + +.. _plugin-reply: + +The Reply plugin +================ + +.. command-notice: + +notice +^^^^^^^^^^^^^ + +Replies with ** in a notice. Use nested commands to your benefit +here. If you want a private notice, nest the private command. + + +.. command-private: + +private +^^^^^^^^^^^^^^ + +Replies with ** in private. Use nested commands to your benefit +here. + + +.. command-replies: + +replies [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Replies with each of its arguments ** in separate replies, depending +the configuration of supybot.reply.oneToOne. + + +.. command-action: + +action +^^^^^^^^^^^^^ + +Replies with ** as an action. use nested commands to your benefit +here. + + +.. command-reply: + +reply +^^^^^^^^^^^^ + +Replies with **. Equivalent to the alias, 'echo $nick: $1'. + + diff --git a/use/plugins/rss.rst b/use/plugins/rss.rst new file mode 100644 index 0000000..fba5e35 --- /dev/null +++ b/use/plugins/rss.rst @@ -0,0 +1,73 @@ + +.. _plugin-rss: + +The RSS plugin +============== + +.. command-info: + +info +^^^^^^^^^^^^^^^ + +Returns information from the given RSS feed, namely the title, +URL, description, and last update date, if available. + + +.. command-remove: + +remove +^^^^^^^^^^^^^ + +Removes the command for looking up RSS feeds at ** from +this plugin. + + +.. command-add: + +add +^^^^^^^^^^^^^^^^ + +Adds a command to this plugin that will look up the RSS feed at the +given URL. + + +.. command-announce-list: + +announce list [] +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the list of feeds announced in **. ** is +only necessary if the message isn't sent in the channel itself. + + +.. command-announce-remove: + +announce remove [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Removes the list of feeds from the current list of announced feeds +in **. Valid feeds include the names of registered feeds as +well as URLs for RSS feeds. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-announce-add: + +announce add [] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Adds the list of feeds to the current list of announced feeds in +**. Valid feeds include the names of registered feeds as +well as URLs for RSS feeds. ** is only necessary if the +message isn't sent in the channel itself. + + +.. command-rss: + +rss [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Gets the title components of the given RSS feed. +If ** is given, return only that many headlines. + + diff --git a/use/plugins/scheduler.rst b/use/plugins/scheduler.rst new file mode 100644 index 0000000..805b9f8 --- /dev/null +++ b/use/plugins/scheduler.rst @@ -0,0 +1,52 @@ + +.. _plugin-scheduler: + +The Scheduler plugin +==================== + +.. command-repeat: + +repeat +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Schedules the command ** to run every ** seconds, +starting now (i.e., the command runs now, and every ** seconds +thereafter). ** is a name by which the command can be +unscheduled. + + +.. command-die: + +die +^^^^ + + + +.. command-list: + +list +^^^^ + +Lists the currently scheduled events. + + +.. command-add: + +add +^^^^^^^^^^^^^^^^^^^^^^^ + +Schedules the command string ** to run ** seconds in the +future. For example, 'scheduler add [seconds 30m] "echo [cpu]"' will +schedule the command "cpu" to be sent to the channel the schedule add +command was given in (with no prefixed nick, a consequence of using +echo). Do pay attention to the quotes in that example. + + +.. command-remove: + +remove +^^^^^^^^^^^ + +Removes the event scheduled with id ** from the schedule. + + diff --git a/use/plugins/seen.rst b/use/plugins/seen.rst new file mode 100644 index 0000000..3dc2957 --- /dev/null +++ b/use/plugins/seen.rst @@ -0,0 +1,65 @@ + +.. _plugin-seen: + +The Seen plugin +=============== + +.. command-user: + +user [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the last time ** was seen and what ** was last seen +saying. This looks up ** in the user seen database, which means +that it could be any nick recognized as user ** that was seen. +** is only necessary if the message isn't sent in the channel +itself. + + +.. command-seen: + +seen [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the last time ** was seen and what ** was last seen +saying. ** is only necessary if the message isn't sent on the +channel itself. ** may contain * as a wildcard. + + +.. command-any: + +any [] [--user ] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the last time ** was seen and what ** was last seen +doing. This includes any form of activity, instead of just PRIVMSGs. +If ** isn't specified, returns the last activity seen in +**. If *--user* is specified, looks up name in the user database +and returns the last time user was active in **. ** is +only necessary if the message isn't sent on the channel itself. + + +.. command-last: + +last [] +^^^^^^^^^^^^^^^^ + +Returns the last thing said in **. ** is only necessary +if the message isn't sent in the channel itself. + + +.. command-die: + +die +^^^^ + + + +.. command-since: + +since [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the messages since ** last left the channel. + + diff --git a/use/plugins/services.rst b/use/plugins/services.rst new file mode 100644 index 0000000..426e44d --- /dev/null +++ b/use/plugins/services.rst @@ -0,0 +1,95 @@ + +.. _plugin-services: + +The Services plugin +=================== + +.. command-disabled: + +disabled +^^^^^^^^^ + + + +.. command-identify: + +identify +^^^^^^^^ + +Identifies with NickServ using the current nick. + + +.. command-nicks: + +nicks +^^^^^ + +Returns the nicks that this plugin is configured to identify and ghost +with. + + +.. command-unban: + +unban [] +^^^^^^^^^^^^^^^^^ + +Attempts to get unbanned by ChanServ in **. ** is only +necessary if the message isn't sent in the channel itself, but chances +are, if you need this command, you're not sending it in the channel +itself. + + +.. command-reset: + +reset +^^^^^^ + + + +.. command-invite: + +invite [] +^^^^^^^^^^^^^^^^^^ + +Attempts to get invited by ChanServ to **. ** is only +necessary if the message isn't sent in the channel itself, but chances +are, if you need this command, you're not sending it in the channel +itself. + + +.. command-password: + +password [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sets the NickServ password for ** to **. If ** is +not given, removes ** from the configured nicks. + + +.. command-ghost: + +ghost [] +^^^^^^^^^^^^^^ + +Ghosts the bot's given nick and takes it. If no nick is given, +ghosts the bot's configured nick and takes it. + + +.. command-voice: + +voice [] +^^^^^^^^^^^^^^^^^ + +Attempts to get voiced by ChanServ in **. ** is only +necessary if the message isn't sent in the channel itself. + + +.. command-op: + +op [] +^^^^^^^^^^^^^^ + +Attempts to get opped by ChanServ in **. ** is only +necessary if the message isn't sent in the channel itself. + + diff --git a/use/plugins/shrinkurl.rst b/use/plugins/shrinkurl.rst new file mode 100644 index 0000000..777af02 --- /dev/null +++ b/use/plugins/shrinkurl.rst @@ -0,0 +1,37 @@ + +.. _plugin-shrinkurl: + +The ShrinkUrl plugin +==================== + +.. command-xrl: + +xrl +^^^^^^^^^ + +Returns an xrl.us version of **. + + +.. command-die: + +die +^^^^ + + + +.. command-tiny: + +tiny +^^^^^^^^^^ + +Returns a TinyURL.com version of ** + + +.. command-ln: + +ln +^^^^^^^^ + +Returns an ln-s.net version of **. + + diff --git a/use/plugins/status.rst b/use/plugins/status.rst new file mode 100644 index 0000000..b770e38 --- /dev/null +++ b/use/plugins/status.rst @@ -0,0 +1,70 @@ + +.. _plugin-status: + +The Status plugin +================= + +.. command-status: + +status +^^^^^^ + +Returns the status of the bot. + + +.. command-cmd: + +cmd +^^^ + +Returns some interesting command-related statistics. + + +.. command-commands: + +commands +^^^^^^^^ + +Returns a list of the commands offered by the bot. + + +.. command-uptime: + +uptime +^^^^^^ + +Returns the amount of time the bot has been running. + + +.. command-threads: + +threads +^^^^^^^ + +Returns the current threads that are active. + + +.. command-net: + +net +^^^ + +Returns some interesting network-related statistics. + + +.. command-server: + +server +^^^^^^ + +Returns the server the bot is on. + + +.. command-cpu: + +cpu +^^^ + +Returns some interesting CPU-related statistics on the bot. + + diff --git a/use/plugins/string.rst b/use/plugins/string.rst new file mode 100644 index 0000000..1345ac5 --- /dev/null +++ b/use/plugins/string.rst @@ -0,0 +1,100 @@ + +.. _plugin-string: + +The String plugin +================= + +.. command-soundex: + +soundex [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the Soundex hash to a given length. The length defaults to +4, since that's the standard length for a soundex hash. For unlimited +length, use 0. + + +.. command-xor: + +xor +^^^^^^^^^^^^^^^^^^^^^ + +Returns ** XOR-encrypted with **. See +http://www.yoe.org/developer/xor.html for information about XOR +encryption. + + +.. command-re: + +re +^^^^^^^^^^^^^^^^^^ + +If ** is of the form m/regexp/flags, returns the portion of +** that matches the regexp. If ** is of the form +s/regexp/replacement/flags, returns the result of applying such a +regexp to **. + + +.. command-levenshtein: + +levenshtein +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the levenshtein distance (also known as the "edit distance" +between ** and **) + + +.. command-decode: + +decode +^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns an un-encoded form of the given text; the valid encodings are +available in the documentation of the Python codecs module: +**. + + +.. command-sha: + +sha +^^^^^^^^^^ + +Returns the SHA hash of a given string. Read +http://www.secure-hash-algorithm-md5-sha-1.co.uk/ for more information +about SHA. + + +.. command-chr: + +chr +^^^^^^^^^^^^ + +Returns the character associated with the 8-bit value ** + + +.. command-len: + +len +^^^^^^^^^^ + +Returns the length of **. + + +.. command-encode: + +encode +^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns an encoded form of the given text; the valid encodings are +available in the documentation of the Python codecs module: +**. + + +.. command-ord: + +ord +^^^^^^^^^^^^ + +Returns the 8-bit value of **. + + diff --git a/use/plugins/success.rst b/use/plugins/success.rst new file mode 100644 index 0000000..c401ca4 --- /dev/null +++ b/use/plugins/success.rst @@ -0,0 +1,13 @@ + +.. _plugin-success: + +The Success plugin +================== + +.. command-die: + +die +^^^^ + + + diff --git a/use/plugins/time.rst b/use/plugins/time.rst new file mode 100644 index 0000000..55701b1 --- /dev/null +++ b/use/plugins/time.rst @@ -0,0 +1,71 @@ + +.. _plugin-time: + +The Time plugin +=============== + +.. command-ctime: + +ctime [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the ctime for **, or the current ctime if +no ** is given. + + +.. command-seconds: + +seconds [y] [w] [d] [h] [m] [s] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the number of seconds in the number of **, **, +**, **, **, and ** 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: + +time [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the current time in ** format, or, if ** is not +given, uses the configurable format for the current channel. If no +** time is given, the current time is used. + + +.. command-elapsed: + +elapsed +^^^^^^^^^^^^^^^^^ + +Returns a pretty string that is the amount of time represented by +**. + + +.. command-at: + +at