From b17bd0fac6629747b2d2b8d3eb2196caf732cdcd Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Tue, 28 Jun 2011 17:29:38 +0200 Subject: [PATCH] Review and update the layout. --- commit.sh | 7 + conf.py | 8 +- conf/channels.conf | 0 conf/ignores.conf | 0 conf/userdata.conf | 0 conf/users.conf | 0 generate_plugin_doc.py | 18 +- logs/messages.log | 289 +++++++++++++++++++ use/plugins/admin.rst | 75 ++--- use/plugins/alias.rst | 26 +- use/plugins/anonymous.rst | 8 +- use/plugins/badwords.rst | 20 +- use/plugins/channel.rst | 458 +++++++++++++++---------------- use/plugins/channellogger.rst | 28 -- use/plugins/channelstats.rst | 28 +- use/plugins/conditional.rst | 205 ++++++-------- use/plugins/config.rst | 85 +++--- use/plugins/ctcp.rst | 7 +- use/plugins/dict.rst | 38 ++- use/plugins/factoids.rst | 145 +++++----- use/plugins/filter.rst | 306 ++++++++++----------- use/plugins/format.rst | 179 ++++++------ use/plugins/games.rst | 48 ++-- use/plugins/google.rst | 66 ++--- use/plugins/herald.rst | 72 +++-- use/plugins/index.rst | 93 ++++++- use/plugins/internet.rst | 21 +- use/plugins/karma.rst | 70 +++-- use/plugins/lart.rst | 7 +- use/plugins/later.rst | 28 +- use/plugins/math.rst | 54 ++-- use/plugins/messageparser.rst | 114 ++++---- use/plugins/misc.rst | 123 ++++----- use/plugins/moobotfactoids.rst | 122 ++++---- use/plugins/network.rst | 106 +++---- use/plugins/news.rst | 70 +++-- use/plugins/nickometer.rst | 14 +- use/plugins/note.rst | 86 +++--- use/plugins/owner.rst | 199 +++++++------- use/plugins/plugin.rst | 64 ++--- use/plugins/plugindownloader.rst | 12 +- use/plugins/praise.rst | 7 +- use/plugins/protector.rst | 7 - use/plugins/quote.rst | 7 +- use/plugins/quotegrabs.rst | 63 +++-- use/plugins/relay.rst | 21 +- use/plugins/reply.rst | 37 ++- use/plugins/rss.rst | 83 +++--- use/plugins/scheduler.rst | 35 +-- use/plugins/seen.rst | 42 +-- use/plugins/services.rst | 92 +++---- use/plugins/shrinkurl.rst | 28 +- use/plugins/status.rst | 56 ++-- use/plugins/string.rst | 127 +++++---- use/plugins/success.rst | 7 - use/plugins/time.rst | 82 +++--- use/plugins/todo.rst | 91 +++--- use/plugins/topic.rst | 267 +++++++++--------- use/plugins/unix.rst | 101 ++++--- use/plugins/url.rst | 14 +- use/plugins/user.rst | 112 ++++---- use/plugins/utilities.rst | 56 ++-- use/plugins/web.rst | 73 ++--- 63 files changed, 2384 insertions(+), 2323 deletions(-) create mode 100755 commit.sh create mode 100644 conf/channels.conf create mode 100644 conf/ignores.conf create mode 100644 conf/userdata.conf create mode 100644 conf/users.conf create mode 100644 logs/messages.log diff --git a/commit.sh b/commit.sh new file mode 100755 index 0000000..6592326 --- /dev/null +++ b/commit.sh @@ -0,0 +1,7 @@ +make html +git commit "$@" +cd _build/html +git add . +git commit "$@" +git push +cd ../.. diff --git a/conf.py b/conf.py index 0e56058..4a1774b 100644 --- a/conf.py +++ b/conf.py @@ -41,7 +41,7 @@ master_doc = 'index' # General information about the project. project = u'Limnoria' -copyright = u'2011, Valentin Lorentz' +copyright = u'2003-2011, the Limnoria/Gribble/Supybot contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -50,7 +50,7 @@ copyright = u'2011, Valentin Lorentz' # The short X.Y version. version = '0.83' # The full version, including alpha/beta/rc tags. -release = '0.83.4.1' +release = '0.83.4.1+limnoria' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -179,7 +179,7 @@ htmlhelp_basename = 'Limnoriadoc' # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'Limnoria.tex', u'Limnoria Documentation', - u'Valentin Lorentz', 'manual'), + u'The Limnoria/Gribble/Supybot contributors', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -212,5 +212,5 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'limnoria', u'Limnoria Documentation', - [u'Valentin Lorentz'], 1) + [u'The Limnoria/Gribble/Supybot contributors'], 1) ] diff --git a/conf/channels.conf b/conf/channels.conf new file mode 100644 index 0000000..e69de29 diff --git a/conf/ignores.conf b/conf/ignores.conf new file mode 100644 index 0000000..e69de29 diff --git a/conf/userdata.conf b/conf/userdata.conf new file mode 100644 index 0000000..e69de29 diff --git a/conf/users.conf b/conf/users.conf new file mode 100644 index 0000000..e69de29 diff --git a/generate_plugin_doc.py b/generate_plugin_doc.py index cfe3947..a6fb46b 100644 --- a/generate_plugin_doc.py +++ b/generate_plugin_doc.py @@ -17,29 +17,33 @@ def main(): supybot = __import__('supybot.plugins.%s.plugin' % pluginName) PluginClass = getattr(supybot.plugins, pluginName).plugin.Class filename = 'use/plugins/%s.rst' % pluginName.lower() - os.unlink(filename) + try: + os.unlink(filename) + except OSError: + pass 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, '') + writeDoc(PluginClass, fd, pluginName.lower()) def writeDoc(PluginClass, fd, prefix): - if prefix != '': - prefix += ' ' + prefix += ' ' for attributeName, attribute in PluginClass.__dict__.items(): if not callable(attribute): continue if not validCommandName.match(attributeName): continue + if attributeName == 'die': + 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': + if syntax == 'takes no arguments' or syntax == '' or syntax == '': syntax = '' else: syntax = ' ' + syntax @@ -62,9 +66,13 @@ def parseHelpString(string): 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')]) + if string.endswith('\n'): + string = string[0:-1] # Put the argument names into italic string = re.sub(r'(<[^>]+>)', r'*\1*', string, re.M) string = re.sub(r'(--[^ ]+)', r'*\1*', string, re.M) + # Turn config variable names into refs + string = re.sub(r'(supybot.[a-zA-Z0-9.]+)', r':ref:`\1`', string, re.M) return string diff --git a/logs/messages.log b/logs/messages.log new file mode 100644 index 0000000..316417b --- /dev/null +++ b/logs/messages.log @@ -0,0 +1,289 @@ +ERROR 2011-06-27T11:35:29 supybot Invalid user dictionary file, resetting to empty. +ERROR 2011-06-27T11:35:29 supybot Exact error: IOError: [Errno 2] No such file or directory: 'conf/users.conf' +ERROR 2011-06-27T11:35:29 supybot Invalid channel database, resetting to empty. +ERROR 2011-06-27T11:35:29 supybot Exact error: IOError: [Errno 2] No such file or directory: 'conf/channels.conf' +WARNING 2011-06-27T11:35:29 supybot Couldn't open ignore database: [Errno 2] No such file or directory: 'conf/ignores.conf' +INFO 2011-06-27T11:35:30 supybot Shutdown initiated. +INFO 2011-06-27T11:35:30 supybot Killing Driver objects. +INFO 2011-06-27T11:35:30 supybot Killing Irc objects. +INFO 2011-06-27T11:35:30 supybot Shutdown complete. +INFO 2011-06-27T11:36:53 supybot Shutdown initiated. +INFO 2011-06-27T11:36:53 supybot Killing Driver objects. +INFO 2011-06-27T11:36:53 supybot Killing Irc objects. +INFO 2011-06-27T11:36:53 supybot Shutdown complete. +INFO 2011-06-27T11:37:03 supybot Shutdown initiated. +INFO 2011-06-27T11:37:03 supybot Killing Driver objects. +INFO 2011-06-27T11:37:03 supybot Killing Irc objects. +INFO 2011-06-27T11:37:03 supybot Shutdown complete. +INFO 2011-06-27T11:38:04 supybot Shutdown initiated. +INFO 2011-06-27T11:38:04 supybot Killing Driver objects. +INFO 2011-06-27T11:38:04 supybot Killing Irc objects. +INFO 2011-06-27T11:38:04 supybot Shutdown complete. +INFO 2011-06-27T11:39:15 supybot Shutdown initiated. +INFO 2011-06-27T11:39:15 supybot Killing Driver objects. +INFO 2011-06-27T11:39:15 supybot Killing Irc objects. +INFO 2011-06-27T11:39:15 supybot Shutdown complete. +INFO 2011-06-27T11:40:08 supybot Shutdown initiated. +INFO 2011-06-27T11:40:08 supybot Killing Driver objects. +INFO 2011-06-27T11:40:08 supybot Killing Irc objects. +INFO 2011-06-27T11:40:08 supybot Shutdown complete. +INFO 2011-06-27T11:54:11 supybot Shutdown initiated. +INFO 2011-06-27T11:54:11 supybot Killing Driver objects. +INFO 2011-06-27T11:54:11 supybot Killing Irc objects. +INFO 2011-06-27T11:54:11 supybot Shutdown complete. +INFO 2011-06-27T12:16:04 supybot Shutdown initiated. +INFO 2011-06-27T12:16:04 supybot Killing Driver objects. +INFO 2011-06-27T12:16:04 supybot Killing Irc objects. +INFO 2011-06-27T12:16:04 supybot Shutdown complete. +INFO 2011-06-27T20:50:57 supybot Shutdown initiated. +INFO 2011-06-27T20:50:57 supybot Killing Driver objects. +INFO 2011-06-27T20:50:57 supybot Killing Irc objects. +INFO 2011-06-27T20:50:57 supybot Shutdown complete. +INFO 2011-06-27T20:51:50 supybot Shutdown initiated. +INFO 2011-06-27T20:51:50 supybot Killing Driver objects. +INFO 2011-06-27T20:51:50 supybot Killing Irc objects. +INFO 2011-06-27T20:51:50 supybot Shutdown complete. +INFO 2011-06-27T20:53:09 supybot Shutdown initiated. +INFO 2011-06-27T20:53:09 supybot Killing Driver objects. +INFO 2011-06-27T20:53:09 supybot Killing Irc objects. +INFO 2011-06-27T20:53:09 supybot Shutdown complete. +INFO 2011-06-27T20:53:34 supybot Shutdown initiated. +INFO 2011-06-27T20:53:34 supybot Killing Driver objects. +INFO 2011-06-27T20:53:34 supybot Killing Irc objects. +INFO 2011-06-27T20:53:34 supybot Shutdown complete. +INFO 2011-06-27T20:54:31 supybot Shutdown initiated. +INFO 2011-06-27T20:54:31 supybot Killing Driver objects. +INFO 2011-06-27T20:54:31 supybot Killing Irc objects. +INFO 2011-06-27T20:54:31 supybot Shutdown complete. +INFO 2011-06-27T20:55:03 supybot Shutdown initiated. +INFO 2011-06-27T20:55:03 supybot Killing Driver objects. +INFO 2011-06-27T20:55:03 supybot Killing Irc objects. +INFO 2011-06-27T20:55:03 supybot Shutdown complete. +INFO 2011-06-27T20:55:17 supybot Shutdown initiated. +INFO 2011-06-27T20:55:17 supybot Killing Driver objects. +INFO 2011-06-27T20:55:17 supybot Killing Irc objects. +INFO 2011-06-27T20:55:17 supybot Shutdown complete. +INFO 2011-06-27T20:55:54 supybot Shutdown initiated. +INFO 2011-06-27T20:55:54 supybot Killing Driver objects. +INFO 2011-06-27T20:55:54 supybot Killing Irc objects. +INFO 2011-06-27T20:55:54 supybot Shutdown complete. +INFO 2011-06-27T20:56:48 supybot Shutdown initiated. +INFO 2011-06-27T20:56:48 supybot Killing Driver objects. +INFO 2011-06-27T20:56:48 supybot Killing Irc objects. +INFO 2011-06-27T20:56:48 supybot Shutdown complete. +INFO 2011-06-27T20:56:59 supybot Shutdown initiated. +INFO 2011-06-27T20:56:59 supybot Killing Driver objects. +INFO 2011-06-27T20:56:59 supybot Killing Irc objects. +INFO 2011-06-27T20:57:00 supybot Shutdown complete. +INFO 2011-06-27T20:58:39 supybot Shutdown initiated. +INFO 2011-06-27T20:58:39 supybot Killing Driver objects. +INFO 2011-06-27T20:58:39 supybot Killing Irc objects. +INFO 2011-06-27T20:58:39 supybot Shutdown complete. +INFO 2011-06-27T20:59:05 supybot Shutdown initiated. +INFO 2011-06-27T20:59:05 supybot Killing Driver objects. +INFO 2011-06-27T20:59:05 supybot Killing Irc objects. +INFO 2011-06-27T20:59:05 supybot Shutdown complete. +INFO 2011-06-27T20:59:28 supybot Shutdown initiated. +INFO 2011-06-27T20:59:28 supybot Killing Driver objects. +INFO 2011-06-27T20:59:28 supybot Killing Irc objects. +INFO 2011-06-27T20:59:28 supybot Shutdown complete. +INFO 2011-06-27T21:02:09 supybot Shutdown initiated. +INFO 2011-06-27T21:02:09 supybot Killing Driver objects. +INFO 2011-06-27T21:02:09 supybot Killing Irc objects. +INFO 2011-06-27T21:02:09 supybot Shutdown complete. +INFO 2011-06-27T21:02:49 supybot Shutdown initiated. +INFO 2011-06-27T21:02:49 supybot Killing Driver objects. +INFO 2011-06-27T21:02:49 supybot Killing Irc objects. +INFO 2011-06-27T21:02:49 supybot Shutdown complete. +INFO 2011-06-27T21:03:07 supybot Shutdown initiated. +INFO 2011-06-27T21:03:07 supybot Killing Driver objects. +INFO 2011-06-27T21:03:07 supybot Killing Irc objects. +INFO 2011-06-27T21:03:07 supybot Shutdown complete. +INFO 2011-06-27T21:03:24 supybot Shutdown initiated. +INFO 2011-06-27T21:03:24 supybot Killing Driver objects. +INFO 2011-06-27T21:03:24 supybot Killing Irc objects. +INFO 2011-06-27T21:03:24 supybot Shutdown complete. +INFO 2011-06-27T21:03:39 supybot Shutdown initiated. +INFO 2011-06-27T21:03:39 supybot Killing Driver objects. +INFO 2011-06-27T21:03:39 supybot Killing Irc objects. +INFO 2011-06-27T21:03:39 supybot Shutdown complete. +INFO 2011-06-27T21:03:42 supybot Shutdown initiated. +INFO 2011-06-27T21:03:42 supybot Killing Driver objects. +INFO 2011-06-27T21:03:42 supybot Killing Irc objects. +INFO 2011-06-27T21:03:42 supybot Shutdown complete. +INFO 2011-06-27T21:04:21 supybot Shutdown initiated. +INFO 2011-06-27T21:04:21 supybot Killing Driver objects. +INFO 2011-06-27T21:04:21 supybot Killing Irc objects. +INFO 2011-06-27T21:04:21 supybot Shutdown complete. +INFO 2011-06-27T22:03:37 supybot Shutdown initiated. +INFO 2011-06-27T22:03:37 supybot Killing Driver objects. +INFO 2011-06-27T22:03:37 supybot Killing Irc objects. +INFO 2011-06-27T22:03:37 supybot Shutdown complete. +INFO 2011-06-27T22:04:03 supybot Shutdown initiated. +INFO 2011-06-27T22:04:03 supybot Killing Driver objects. +INFO 2011-06-27T22:04:03 supybot Killing Irc objects. +INFO 2011-06-27T22:04:03 supybot Shutdown complete. +INFO 2011-06-27T22:06:18 supybot Shutdown initiated. +INFO 2011-06-27T22:06:18 supybot Killing Driver objects. +INFO 2011-06-27T22:06:18 supybot Killing Irc objects. +INFO 2011-06-27T22:06:18 supybot Shutdown complete. +INFO 2011-06-27T22:06:20 supybot Shutdown initiated. +INFO 2011-06-27T22:06:20 supybot Killing Driver objects. +INFO 2011-06-27T22:06:20 supybot Killing Irc objects. +INFO 2011-06-27T22:06:20 supybot Shutdown complete. +INFO 2011-06-27T22:06:46 supybot Shutdown initiated. +INFO 2011-06-27T22:06:46 supybot Killing Driver objects. +INFO 2011-06-27T22:06:46 supybot Killing Irc objects. +INFO 2011-06-27T22:06:46 supybot Shutdown complete. +INFO 2011-06-27T22:09:31 supybot Shutdown initiated. +INFO 2011-06-27T22:09:31 supybot Killing Driver objects. +INFO 2011-06-27T22:09:31 supybot Killing Irc objects. +INFO 2011-06-27T22:09:31 supybot Shutdown complete. +INFO 2011-06-27T22:09:46 supybot Shutdown initiated. +INFO 2011-06-27T22:09:46 supybot Killing Driver objects. +INFO 2011-06-27T22:09:46 supybot Killing Irc objects. +INFO 2011-06-27T22:09:46 supybot Shutdown complete. +INFO 2011-06-27T22:24:09 supybot Shutdown initiated. +INFO 2011-06-27T22:24:09 supybot Killing Driver objects. +INFO 2011-06-27T22:24:09 supybot Killing Irc objects. +INFO 2011-06-27T22:24:09 supybot Shutdown complete. +INFO 2011-06-27T22:24:35 supybot Shutdown initiated. +INFO 2011-06-27T22:24:35 supybot Killing Driver objects. +INFO 2011-06-27T22:24:35 supybot Killing Irc objects. +INFO 2011-06-27T22:24:35 supybot Shutdown complete. +INFO 2011-06-27T22:25:01 supybot Shutdown initiated. +INFO 2011-06-27T22:25:01 supybot Killing Driver objects. +INFO 2011-06-27T22:25:01 supybot Killing Irc objects. +INFO 2011-06-27T22:25:01 supybot Shutdown complete. +INFO 2011-06-27T22:25:17 supybot Shutdown initiated. +INFO 2011-06-27T22:25:17 supybot Killing Driver objects. +INFO 2011-06-27T22:25:17 supybot Killing Irc objects. +INFO 2011-06-27T22:25:17 supybot Shutdown complete. +INFO 2011-06-27T22:25:26 supybot Shutdown initiated. +INFO 2011-06-27T22:25:26 supybot Killing Driver objects. +INFO 2011-06-27T22:25:26 supybot Killing Irc objects. +INFO 2011-06-27T22:25:26 supybot Shutdown complete. +INFO 2011-06-27T22:25:32 supybot Shutdown initiated. +INFO 2011-06-27T22:25:32 supybot Killing Driver objects. +INFO 2011-06-27T22:25:32 supybot Killing Irc objects. +INFO 2011-06-27T22:25:32 supybot Shutdown complete. +INFO 2011-06-27T22:26:22 supybot Shutdown initiated. +INFO 2011-06-27T22:26:22 supybot Killing Driver objects. +INFO 2011-06-27T22:26:22 supybot Killing Irc objects. +INFO 2011-06-27T22:26:22 supybot Shutdown complete. +INFO 2011-06-27T22:32:20 supybot Shutdown initiated. +INFO 2011-06-27T22:32:20 supybot Killing Driver objects. +INFO 2011-06-27T22:32:20 supybot Killing Irc objects. +INFO 2011-06-27T22:32:20 supybot Shutdown complete. +INFO 2011-06-27T22:33:34 supybot Shutdown initiated. +INFO 2011-06-27T22:33:34 supybot Killing Driver objects. +INFO 2011-06-27T22:33:34 supybot Killing Irc objects. +INFO 2011-06-27T22:33:35 supybot Shutdown complete. +INFO 2011-06-27T22:35:09 supybot Shutdown initiated. +INFO 2011-06-27T22:35:09 supybot Killing Driver objects. +INFO 2011-06-27T22:35:09 supybot Killing Irc objects. +INFO 2011-06-27T22:35:10 supybot Shutdown complete. +INFO 2011-06-27T22:35:58 supybot Shutdown initiated. +INFO 2011-06-27T22:35:58 supybot Killing Driver objects. +INFO 2011-06-27T22:35:58 supybot Killing Irc objects. +INFO 2011-06-27T22:35:58 supybot Shutdown complete. +INFO 2011-06-27T22:36:24 supybot Shutdown initiated. +INFO 2011-06-27T22:36:24 supybot Killing Driver objects. +INFO 2011-06-27T22:36:24 supybot Killing Irc objects. +INFO 2011-06-27T22:36:24 supybot Shutdown complete. +INFO 2011-06-28T07:59:11 supybot Shutdown initiated. +INFO 2011-06-28T07:59:11 supybot Killing Driver objects. +INFO 2011-06-28T07:59:11 supybot Killing Irc objects. +INFO 2011-06-28T07:59:11 supybot Shutdown complete. +INFO 2011-06-28T08:07:59 supybot Shutdown initiated. +INFO 2011-06-28T08:07:59 supybot Killing Driver objects. +INFO 2011-06-28T08:07:59 supybot Killing Irc objects. +INFO 2011-06-28T08:07:59 supybot Shutdown complete. +INFO 2011-06-28T08:08:16 supybot Shutdown initiated. +INFO 2011-06-28T08:08:16 supybot Killing Driver objects. +INFO 2011-06-28T08:08:16 supybot Killing Irc objects. +INFO 2011-06-28T08:08:16 supybot Shutdown complete. +INFO 2011-06-28T08:13:07 supybot Shutdown initiated. +INFO 2011-06-28T08:13:07 supybot Killing Driver objects. +INFO 2011-06-28T08:13:07 supybot Killing Irc objects. +INFO 2011-06-28T08:13:07 supybot Shutdown complete. +INFO 2011-06-28T08:20:55 supybot Shutdown initiated. +INFO 2011-06-28T08:20:55 supybot Killing Driver objects. +INFO 2011-06-28T08:20:55 supybot Killing Irc objects. +INFO 2011-06-28T08:20:55 supybot Shutdown complete. +INFO 2011-06-28T08:31:44 supybot Shutdown initiated. +INFO 2011-06-28T08:31:44 supybot Killing Driver objects. +INFO 2011-06-28T08:31:44 supybot Killing Irc objects. +INFO 2011-06-28T08:31:44 supybot Shutdown complete. +INFO 2011-06-28T08:32:32 supybot Shutdown initiated. +INFO 2011-06-28T08:32:32 supybot Killing Driver objects. +INFO 2011-06-28T08:32:32 supybot Killing Irc objects. +INFO 2011-06-28T08:32:32 supybot Shutdown complete. +INFO 2011-06-28T08:32:45 supybot Shutdown initiated. +INFO 2011-06-28T08:32:45 supybot Killing Driver objects. +INFO 2011-06-28T08:32:45 supybot Killing Irc objects. +INFO 2011-06-28T08:32:45 supybot Shutdown complete. +INFO 2011-06-28T09:15:23 supybot Shutdown initiated. +INFO 2011-06-28T09:15:23 supybot Killing Driver objects. +INFO 2011-06-28T09:15:23 supybot Killing Irc objects. +INFO 2011-06-28T09:15:23 supybot Shutdown complete. +INFO 2011-06-28T09:16:17 supybot Shutdown initiated. +INFO 2011-06-28T09:16:17 supybot Killing Driver objects. +INFO 2011-06-28T09:16:17 supybot Killing Irc objects. +INFO 2011-06-28T09:16:17 supybot Shutdown complete. +INFO 2011-06-28T09:16:55 supybot Shutdown initiated. +INFO 2011-06-28T09:16:55 supybot Killing Driver objects. +INFO 2011-06-28T09:16:55 supybot Killing Irc objects. +INFO 2011-06-28T09:16:55 supybot Shutdown complete. +INFO 2011-06-28T09:17:58 supybot Shutdown initiated. +INFO 2011-06-28T09:17:58 supybot Killing Driver objects. +INFO 2011-06-28T09:17:58 supybot Killing Irc objects. +INFO 2011-06-28T09:17:58 supybot Shutdown complete. +INFO 2011-06-28T09:18:28 supybot Shutdown initiated. +INFO 2011-06-28T09:18:28 supybot Killing Driver objects. +INFO 2011-06-28T09:18:28 supybot Killing Irc objects. +INFO 2011-06-28T09:18:28 supybot Shutdown complete. +INFO 2011-06-28T09:18:37 supybot Shutdown initiated. +INFO 2011-06-28T09:18:37 supybot Killing Driver objects. +INFO 2011-06-28T09:18:37 supybot Killing Irc objects. +INFO 2011-06-28T09:18:37 supybot Shutdown complete. +INFO 2011-06-28T09:19:04 supybot Shutdown initiated. +INFO 2011-06-28T09:19:04 supybot Killing Driver objects. +INFO 2011-06-28T09:19:04 supybot Killing Irc objects. +INFO 2011-06-28T09:19:04 supybot Shutdown complete. +INFO 2011-06-28T09:25:11 supybot Shutdown initiated. +INFO 2011-06-28T09:25:11 supybot Killing Driver objects. +INFO 2011-06-28T09:25:11 supybot Killing Irc objects. +INFO 2011-06-28T09:25:11 supybot Shutdown complete. +INFO 2011-06-28T09:25:39 supybot Shutdown initiated. +INFO 2011-06-28T09:25:39 supybot Killing Driver objects. +INFO 2011-06-28T09:25:39 supybot Killing Irc objects. +INFO 2011-06-28T09:25:39 supybot Shutdown complete. +INFO 2011-06-28T09:26:06 supybot Shutdown initiated. +INFO 2011-06-28T09:26:06 supybot Killing Driver objects. +INFO 2011-06-28T09:26:06 supybot Killing Irc objects. +INFO 2011-06-28T09:26:06 supybot Shutdown complete. +INFO 2011-06-28T10:19:24 supybot Shutdown initiated. +INFO 2011-06-28T10:19:24 supybot Killing Driver objects. +INFO 2011-06-28T10:19:24 supybot Killing Irc objects. +INFO 2011-06-28T10:19:24 supybot Shutdown complete. +INFO 2011-06-28T10:19:41 supybot Shutdown initiated. +INFO 2011-06-28T10:19:41 supybot Killing Driver objects. +INFO 2011-06-28T10:19:41 supybot Killing Irc objects. +INFO 2011-06-28T10:19:41 supybot Shutdown complete. +INFO 2011-06-28T10:20:24 supybot Shutdown initiated. +INFO 2011-06-28T10:20:24 supybot Killing Driver objects. +INFO 2011-06-28T10:20:24 supybot Killing Irc objects. +INFO 2011-06-28T10:20:24 supybot Shutdown complete. +INFO 2011-06-28T10:20:59 supybot Shutdown initiated. +INFO 2011-06-28T10:20:59 supybot Killing Driver objects. +INFO 2011-06-28T10:20:59 supybot Killing Irc objects. +INFO 2011-06-28T10:20:59 supybot Shutdown complete. +INFO 2011-06-28T10:21:28 supybot Shutdown initiated. +INFO 2011-06-28T10:21:28 supybot Killing Driver objects. +INFO 2011-06-28T10:21:28 supybot Killing Irc objects. +INFO 2011-06-28T10:21:28 supybot Shutdown complete. +INFO 2011-06-28T11:58:43 supybot Shutdown initiated. +INFO 2011-06-28T11:58:43 supybot Killing Driver objects. +INFO 2011-06-28T11:58:43 supybot Killing Irc objects. +INFO 2011-06-28T11:58:43 supybot Shutdown complete. diff --git a/use/plugins/admin.rst b/use/plugins/admin.rst index 5382442..4cfa58d 100644 --- a/use/plugins/admin.rst +++ b/use/plugins/admin.rst @@ -4,7 +4,29 @@ The Admin plugin ================ -.. _command-channels: +Capabilities +------------ + +.. _command-channel-capability-add: + +capability add +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Gives the user specified by ** (or the user to whom ** +currently maps) the specified capability ** + +.. _command-channel-capability-remove: + +capability remove +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Takes from the user specified by ** (or the user to whom +** currently maps) the specified capability ** + +Channels +-------- + +.. _command-channel-channels: channels ^^^^^^^^ @@ -12,8 +34,15 @@ channels Returns the channels the bot is on. Must be given in private, in order to protect the secrecy of secret channels. +.. _command-channel-join: -.. _command-part: +join [] +^^^^^^^^^^^^^^^^^^^^^^ + +Tell the bot to join the given channel. If ** is given, it is used +when attempting to join the channel. + +.. _command-channel-part: part [] [] ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -23,16 +52,17 @@ 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. +Ignores +------- -.. _command-ignore-list: +.. _command-channel-ignore-list: ignore list ^^^^^^^^^^^ Lists the hostmasks that the bot is ignoring. - -.. _command-ignore-remove: +.. _command-channel-ignore-remove: ignore remove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -40,8 +70,7 @@ ignore remove This will remove the persistent ignore on ** or the hostmask currently associated with **. - -.. _command-ignore-add: +.. _command-channel-ignore-add: ignore add [] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -51,35 +80,10 @@ 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. +Miscellaneous +------------- -.. _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: +.. _command-channel-nick: nick [] ^^^^^^^^^^^^^ @@ -87,4 +91,3 @@ 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 index 28ae266..c793306 100644 --- a/use/plugins/alias.rst +++ b/use/plugins/alias.rst @@ -4,31 +4,27 @@ The Alias plugin ================ -.. _command-lock: +Protecting +---------- + +.. _command-channel-lock: lock ^^^^^^^^^^^^ Locks an alias so that no one else can change it. - -.. _command-unlock: +.. _command-channel-unlock: unlock ^^^^^^^^^^^^^^ Unlocks an alias so that people can define new aliases over it. +Adding and removing +------------------- -.. _command-remove: - -remove -^^^^^^^^^^^^^ - -Removes the given alias, if unlocked. - - -.. _command-add: +.. _command-channel-add: add ^^^^^^^^^^^^^^^^^^ @@ -40,4 +36,10 @@ arguments. $1, $2, etc. can be used for required arguments. @1, @2, etc. can be used for optional arguments. $* simply means "all remaining arguments," and cannot be combined with optional arguments. +.. _command-channel-remove: + +remove +^^^^^^^^^^^^^ + +Removes the given alias, if unlocked. diff --git a/use/plugins/anonymous.rst b/use/plugins/anonymous.rst index 8033e8c..12221d0 100644 --- a/use/plugins/anonymous.rst +++ b/use/plugins/anonymous.rst @@ -4,20 +4,18 @@ The Anonymous plugin ==================== -.. _command-do: +.. _command-channel-do: do ^^^^^^^^^^^^^^^^^^^^^ Performs ** in **. - -.. _command-say: +.. _command-channel-say: say ^^^^^^^^^^^^^^^^^^^^^^^^^ Sends ** to **. Can only send to ** if -supybot.plugins.Anonymous.allowPrivateTarget is True. - +:ref:`supybot.plugins.Anonymous.allowPrivateTarget` is True. diff --git a/use/plugins/badwords.rst b/use/plugins/badwords.rst index 79fefd6..a73549c 100644 --- a/use/plugins/badwords.rst +++ b/use/plugins/badwords.rst @@ -4,34 +4,24 @@ The BadWords plugin =================== -.. _command-sub: - -sub -^^^^ - - - -.. _command-list: +.. _command-channel-list: list ^^^^ Returns the list of words being censored. - -.. _command-remove: +.. _command-channel-remove: remove [ ...] ^^^^^^^^^^^^^^^^^^^^^^^^^^ -Removes **s from the list of words being censored. +Removes *s* from the list of words being censored. - -.. _command-add: +.. _command-channel-add: add [ ...] ^^^^^^^^^^^^^^^^^^^^^^^ -Adds all **s to the list of words being censored. - +Adds all *s* to the list of words being censored. diff --git a/use/plugins/channel.rst b/use/plugins/channel.rst index a420633..56f92ec 100644 --- a/use/plugins/channel.rst +++ b/use/plugins/channel.rst @@ -4,35 +4,17 @@ The Channel plugin ================== -.. _command-unmoderate: +Lobotomy +-------- -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: +.. _command-channel-lobotomy-list: lobotomy list ^^^^^^^^^^^^^ Returns the channels in which this bot is lobotomized. - -.. _command-lobotomy-remove: +.. _command-channel-lobotomy-remove: lobotomy remove [] ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -42,8 +24,7 @@ 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: +.. _command-channel-lobotomy-add: lobotomy add [] ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -53,8 +34,28 @@ 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. +(Un)setting modes +----------------- -.. _command-deop: +.. _command-channel-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-channel-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-channel-deop: deop [] [ ...] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -63,18 +64,7 @@ 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: +.. _command-channel-limit: limit [] [] ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -83,8 +73,7 @@ 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: +.. _command-channel-moderate: moderate [] ^^^^^^^^^^^^^^^^^^^^ @@ -93,8 +82,7 @@ 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: +.. _command-channel-unban: unban [] [] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -105,41 +93,7 @@ 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: +.. _command-channel-dehalfop: dehalfop [] [ ...] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -148,29 +102,7 @@ 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: +.. _command-channel-key: key [] [] ^^^^^^^^^^^^^^^^^^^^^^^ @@ -179,131 +111,7 @@ 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: +.. _command-channel-halfop: halfop [] [ ...] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -313,8 +121,7 @@ If you have the #channel,halfop capability, this will give all the will give you halfops. ** is only necessary if the message isn't sent in the channel itself. - -.. _command-mode: +.. _command-channel-mode: mode [] [ ...] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -323,8 +130,7 @@ 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: +.. _command-channel-ban-list: ban list [] ^^^^^^^^^^^^^^^^^^^^ @@ -332,8 +138,7 @@ ban list [] If you have the #channel,op capability, this will show you the current persistent bans on #channel. - -.. _command-ban-remove: +.. _command-channel-ban-remove: ban remove [] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -342,8 +147,7 @@ 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: +.. _command-channel-ban-add: ban add [] [] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -358,8 +162,7 @@ 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: +.. _command-channel-voice: voice [] [ ...] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -369,8 +172,7 @@ If you have the #channel,voice capability, this will voice all the voice you. ** is only necessary if the message isn't sent in the channel itself. - -.. _command-op: +.. _command-channel-op: op [] [ ...] ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -380,4 +182,188 @@ 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. +Inviting and kicking users +-------------------------- +.. _command-channel-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-channel-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-channel-kban: + +kban [] [--{exact,nick,user,host}] [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have the #channel,op capability, this will kickban ** for +as many seconds as you specify, or else (if you specify 0 seconds or +don't specify a number of seconds) it will ban the person indefinitely. +*--exact* bans only the exact hostmask; *--nick* bans just the nick; +*--user* bans just the user, and *--host* bans just the host. You can +combine these options as you choose. ** is a reason to give for +the kick. +** is only necessary if the message isn't sent in the channel +itself. + +.. _command-channel-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. + +Utitilies +--------- + +.. _command-channel-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-channel-alert: + +alert [] +^^^^^^^^^^^^^^^^^^^^^^^^ + +Sends ** to all the users in ** who have the **,op +capability. + +.. _command-channel-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. + +Ignores + +.. _command-channel-cycle: + +cycle [] +------- + +.. _command-channel-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-channel-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-channel-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. + +Capabilities +------------ + +.. _command-channel-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-channel-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-channel-capability-list: + +capability list [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the capabilities present on the **. ** is +only necessary if the message isn't sent in the channel itself. + +.. _command-channel-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-channel-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-channel-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-channel-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. diff --git a/use/plugins/channellogger.rst b/use/plugins/channellogger.rst index 62610e7..d7445ef 100644 --- a/use/plugins/channellogger.rst +++ b/use/plugins/channellogger.rst @@ -4,31 +4,3 @@ 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 index a2890dc..6e3474e 100644 --- a/use/plugins/channelstats.rst +++ b/use/plugins/channelstats.rst @@ -4,27 +4,19 @@ The ChannelStats plugin ======================= -.. _command-stats: +.. _command-channelstats-stats: -stats [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^ +channelstats 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-channelstats-rank: -.. _command-die: - -die -^^^^ - - - -.. _command-rank: - -rank [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +channelstats rank [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the ranking of users according to the given stat expression. Valid variables in the stat expression include 'msgs', 'chars', @@ -32,13 +24,11 @@ Valid variables in the stat expression include 'msgs', 'chars', 'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical expression involving those variables is permitted. +.. _command-channelstats-channelstats: -.. _command-channelstats: - -channelstats [] -^^^^^^^^^^^^^^^^^^^^^^^^ +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 index 29af434..88f5407 100644 --- a/use/plugins/conditional.rst +++ b/use/plugins/conditional.rst @@ -4,173 +4,148 @@ The Conditional plugin ====================== -.. _command-gt: +Numeric comparison +------------------ -gt - - Does a string comparison on and . - Returns true if is greater than . -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-conditional-nlt: +conditional nlt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a numeric comparison on ** and **. +Returns true if ** is less than **. -.. _command-nlt: +.. _command-conditional-nne: -nlt - - Does a numeric comparison on and . - Returns true if is less than . -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +conditional nne +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a numeric comparison on ** and **. +Returns true if they are not equal. +.. _command-conditional-nle: -.. _command-nne: +conditional nle +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -nne - - Does a numeric comparison on and . - Returns true if they are not equal. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a numeric comparison on ** and **. +Returns true if ** is less than or equal to **. +.. _command-conditional-nge: +conditional nge +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. _command-ge: +Does a numeric comparison on ** and **. +Returns true if ** is greater than or equal to **. -ge - - Does a string comparison on and . - Returns true if is greater than or equal to . -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-conditional-nceq: +conditional nceq +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a numeric comparison on ** and **. +Returns true if they are equal. -.. _command-cor: +.. _command-conditional-ngt: -cor [ ... ] - - Returns true if any one of conditions supplied evaluates to true. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +conditional ngt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a numeric comparison on ** and **. +Returns true if they ** is greater than **. +String comparison +----------------- -.. _command-nle: +.. _command-conditional-le: -nle - - Does a numeric comparison on and . - Returns true if is less than or equal to . -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +conditional le +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a string comparison on ** and **. +Returns true if ** is less than or equal to **. +.. _command-conditional-ceq: -.. _command-ceq: +conditional ceq +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -ceq - - Does a string comparison on and . - Returns true if they are equal. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a string comparison on ** and **. +Returns true if they are equal. +.. _command-conditional-gt: +conditional gt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. _command-nge: +Does a string comparison on ** and **. +Returns true if ** is greater than **. -nge - - Does a numeric comparison on and . - Returns true if is greater than or equal to . -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-conditional-ge: +conditional ge +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a string comparison on ** and **. +Returns true if ** is greater than or equal to **. -.. _command-cxor: +.. _command-conditional-ne: -cxor [ ... ] - - Returns true if only one of conditions supplied evaluates to true. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +conditional ne +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a string comparison on ** and **. +Returns true if they are not equal. +.. _command-conditional-lt: -.. _command-le: +conditional lt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -le - - Does a string comparison on and . - Returns true if is less than or equal to . -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Does a string comparison on ** and **. +Returns true if ** is less than **. +.. _command-conditional-match: +conditional match +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. _command-cif: +Determines if ** is a substring of **. +Returns true if ** is contained in **. -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. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Logical operators +----------------- +.. _command-conditional-cand: +conditional cand [ ... ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. _command-ne: +Returns true if all conditions supplied evaluate to true. -ne - - Does a string comparison on and . - Returns true if they are not equal. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-conditional-cxor: +conditional cxor [ ... ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Returns true if only one of conditions supplied evaluates to true. -.. _command-cand: +.. _command-conditional-cor: -cand [ ... ] - - Returns true if all conditions supplied evaluate to true. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +conditional cor [ ... ] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Returns true if any one of conditions supplied evaluates to true. +.. _command-conditional-cif: -.. _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 . -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +conditional 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. diff --git a/use/plugins/config.rst b/use/plugins/config.rst index c29b783..4c5c6f7 100644 --- a/use/plugins/config.rst +++ b/use/plugins/config.rst @@ -4,26 +4,27 @@ The Config plugin ================= -.. _command-help: +Accessing config +---------------- -help -^^^^^^^^^^^ +.. _command-config-help: + +config help +^^^^^^^^^^^^^^^^^^ Returns the description of the configuration variable **. +.. _command-config-default: -.. _command-default: - -default -^^^^^^^^^^^^^^ +config default +^^^^^^^^^^^^^^^^^^^^^ Returns the default value of the configuration variable **. +.. _command-config-list: -.. _command-list: - -list -^^^^^^^^^^^^ +config list +^^^^^^^^^^^^^^^^^^^ Returns the configuration variables available under the given configuration **. If a variable has values under it, it is @@ -31,53 +32,51 @@ preceded by an '@' sign. If a variable is a 'ChannelValue', that is, it can be separately configured for each channel using the 'channel' command in this plugin, it is preceded by an '#' sign. +.. _command-config-search: -.. _command-search: - -search -^^^^^^^^^^^^^ +config search +^^^^^^^^^^^^^^^^^^^^ Searches for ** in the current configuration variables. +.. _command-config-channel: -.. _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 [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +config 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: +.. _command-config-config: -config [] -^^^^^^^^^^^^^^^^^^^^^^^ +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. +Maintenance +----------- + +.. _command-config-reload: + +config reload +^^^^^^^^^^^^^ + +Reloads the various configuration files (user database, channel +database, registry, etc.). + +.. _command-config-export: + +config 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. diff --git a/use/plugins/ctcp.rst b/use/plugins/ctcp.rst index 7aa4d3f..bcf49db 100644 --- a/use/plugins/ctcp.rst +++ b/use/plugins/ctcp.rst @@ -4,10 +4,10 @@ The Ctcp plugin =============== -.. _command-version: +.. _command-ctcp-version: -version [] [--nicks] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +ctcp version [] [--nicks] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Sends a CTCP VERSION to **, returning the various version strings returned. It waits for 10 seconds before returning @@ -15,4 +15,3 @@ 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 index 6a505b6..c1e9d04 100644 --- a/use/plugins/dict.rst +++ b/use/plugins/dict.rst @@ -4,40 +4,36 @@ The Dict plugin =============== -.. _command-synonym: +.. _command-dict-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. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +dict synonym [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Gets a random synonym from the Moby Thesaurus (moby-thes) database. +If given many words, gets a random synonym for each of them. -.. _command-dict: +Quote phrases to have them treated as one lookup word. -dict [] -^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-dict-dict: + +dict dict [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Looks up the definition of ** on the dictd server specified by -the supybot.plugins.Dict.server config variable. +the :ref:`supybot.plugins.Dict.server` config variable. +.. _command-dict-random: -.. _command-random: - -random -^^^^^^ +dict random +^^^^^^^^^^^ Returns a random valid dictionary. +.. _command-dict-dictionaries: -.. _command-dictionaries: - -dictionaries -^^^^^^^^^^^^ +dict dictionaries +^^^^^^^^^^^^^^^^^ Returns the dictionaries valid for the dict command. - diff --git a/use/plugins/factoids.rst b/use/plugins/factoids.rst index af073f7..8855c2b 100644 --- a/use/plugins/factoids.rst +++ b/use/plugins/factoids.rst @@ -4,53 +4,50 @@ The Factoids plugin =================== -.. _command-info: +Reading factoids +---------------- -info [] -^^^^^^^^^^^^^^^^^^^^^^ +.. _command-factoids-info: + +factoids info [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Gives information about the factoid(s) associated with **. ** is only necessary if the message isn't sent in the channel itself. +.. _command-factoids-random: -.. _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 [] -^^^^^^^^^^^^^^^^^^ +factoids random [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns a random factoid from the database for **. ** is only necessary if the message isn't sent in the channel itself. +.. _command-factoids-search: -.. _command-rank: +factoids search [] [--values] [--{regexp} ] [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -rank [] [--plain] [--alpha] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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-factoids-whatis: + +factoids 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-factoids-rank: + +factoids 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 @@ -65,43 +62,50 @@ alphabetically, instead of by rank. ** is only necessary if the message isn't sent in the channel itself. +Administration +-------------- -.. _command-unlock: +.. _command-factoids-learn: -unlock [] -^^^^^^^^^^^^^^^^^^^^^^^^ +factoids learn [] WORD +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Associates ** with **. ** is only +necessary if the message isn't sent on the channel +itself. The WORD (defined in :ref:`supybot.plugins.Factoids.learnSeparator`) +is necessary to separate the +key from the value. It can be changed to another word +via the :ref:`supybot.plugins.Factoids.learnSeparator` registry value. + +.. _command-factoids-forget: + +factoids forget [] [|*] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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-factoids-unlock: + +factoids 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-factoids-alias: -.. _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 [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +factoids alias [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Adds a new key ** for factoid associated with **. ** is only necessary if there's more than one factoid associated @@ -110,23 +114,20 @@ with **. The same action can be accomplished by using the 'learn' function with a new key but an existing (verbatim) factoid content. +.. _command-factoids-change: -.. _command-change: - -change [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +factoids change [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Changes the factoid #** associated with ** according to **. +.. _command-factoids-lock: -.. _command-lock: - -lock [] -^^^^^^^^^^^^^^^^^^^^^^ +factoids 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 index c0a1264..3b13450 100644 --- a/use/plugins/filter.rst +++ b/use/plugins/filter.rst @@ -4,206 +4,198 @@ The Filter plugin ================= -.. _command-undup: +Administration +-------------- -undup -^^^^^^^^^^^^ +.. _command-filter-outfilter: -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 [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +filter 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. +Encoding and decoding +--------------------- -.. _command-spellit: +.. _command-filter-hexlify: -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 -^^^^^^^^^^^^^^ +filter 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-filter-unhexlify: -.. _command-unmorse: +filter unhexlify +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -unmorse -^^^^^^^^^^^^^^^^^^^^^^^^^ +Returns the string corresponding to **. Obviously, +** must be a string of hexadecimal digits. + +.. _command-filter-binary: + +filter binary +^^^^^^^^^^^^^^^^^^^^ + +Returns the binary representation of **. + +.. _command-filter-unbinary: + +filter unbinary +^^^^^^^^^^^^^^^^^^^^^^ + +Returns the character representation of binary **. +Assumes ASCII, 8 digits per character. + +.. _command-filter-morse: + +filter morse +^^^^^^^^^^^^^^^^^^^ + +Gives the Morse code equivalent of a given string. + +.. _command-filter-unmorse: + +filter unmorse +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Does the reverse of the morse command. -.. _command-squish: +Colors +------ -squish -^^^^^^^^^^^^^ +.. _command-filter-stripcolor: -Removes all the spaces from **. +filter stripcolor +^^^^^^^^^^^^^^^^^^^^^^^^ +Returns ** stripped of all color codes. -.. _command-reverse: +.. _command-filter-colorize: -reverse -^^^^^^^^^^^^^^ +filter colorize +^^^^^^^^^^^^^^^^^^^^^^ -Reverses **. +Returns ** with each character randomly colorized. +.. _command-filter-rainbow: -.. _command-azn: +filter rainbow +^^^^^^^^^^^^^^^^^^^^^ -azn -^^^^^^^^^^ +Returns ** colorized like a rainbow. -Returns ** with the l's made into r's and r's made into l's. +Utils +----- +.. _command-filter-shrink: -.. _command-gnu: - -gnu -^^^^^^^^^^ - -Returns ** as GNU/RMS would say it. - - -.. _command-jeffk: - -jeffk -^^^^^^^^^^^^ - -Returns ** as if JeffK had said it himself. - - -.. _command-shrink: - -shrink -^^^^^^^^^^^^^ +filter shrink +^^^^^^^^^^^^^^^^^^^^ Returns ** with each word longer than -supybot.plugins.Filter.shrink.minimum being shrunken (i.e., like +:ref:`supybot.plugins.Filter.shrink.minimum` being shrunken (i.e., like "internationalization" becomes "i18n"). +.. _command-filter-uniud: -.. _command-uniud: - -uniud -^^^^^^^^^^^^ +filter uniud +^^^^^^^^^^^^^^^^^^^ Returns ** rotated 180 degrees. Only really works for ASCII printable characters. +.. _command-filter-scramble: -.. _command-scramble: - -scramble -^^^^^^^^^^^^^^^ +filter 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. +Fun +--- + +.. _command-filter-undup: + +filter undup +^^^^^^^^^^^^^^^^^^^ + +Returns **, with all consecutive duplicated letters removed. + +.. _command-filter-hebrew: + +filter 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-filter-leet: + +filter leet +^^^^^^^^^^^^^^^^^^ + +Returns the l33tspeak version of ** + +.. _command-filter-lithp: + +filter lithp +^^^^^^^^^^^^^^^^^^^ + +Returns the lisping version of ** + +.. _command-filter-spellit: + +filter spellit +^^^^^^^^^^^^^^^^^^^^^ + +Returns **, phonetically spelled out. + +.. _command-filter-aol: + +filter aol +^^^^^^^^^^^^^^^^^ + +Returns ** as if an AOLuser had said it. + +.. _command-filter-squish: + +filter squish +^^^^^^^^^^^^^^^^^^^^ + +Removes all the spaces from **. + +.. _command-filter-reverse: + +filter reverse +^^^^^^^^^^^^^^^^^^^^^ + +Reverses **. + +.. _command-filter-azn: + +filter azn +^^^^^^^^^^^^^^^^^ + +Returns ** with the l's made into r's and r's made into l's. + +.. _command-filter-gnu: + +filter gnu +^^^^^^^^^^^^^^^^^ + +Returns ** as GNU/RMS would say it. + +.. _command-filter-jeffk: + +filter jeffk +^^^^^^^^^^^^^^^^^^^ + +Returns ** as if JeffK had said it himself. diff --git a/use/plugins/format.rst b/use/plugins/format.rst index b01c31b..1177110 100644 --- a/use/plugins/format.rst +++ b/use/plugins/format.rst @@ -4,142 +4,135 @@ The Format plugin ================= -.. _command-upper: +Capitals +-------- -upper -^^^^^^^^^^^^ +.. _command-format-upper: + +format upper +^^^^^^^^^^^^^^^^^^^ Returns ** uppercased. +.. _command-format-capitalize: -.. _command-bold: +format capitalize +^^^^^^^^^^^^^^^^^^^^^^^^ -bold -^^^^^^^^^^^ +Returns ** capitalized. -Returns ** bolded. +.. _command-format-lower: +format lower +^^^^^^^^^^^^^^^^^^^ -.. _command-format: +Returns ** lowercased. -format [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-format-title: + +format title +^^^^^^^^^^^^^^^^^^^ + +Returns ** titlecased. + +Text modifications +------------------ + +.. _command-format-format: + +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-format-color: -.. _command-color: - -color [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +format color [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns ** with foreground color ** and background color ** (if given) +.. _command-format-repr: -.. _command-repr: - -repr -^^^^^^^^^^^ +format repr +^^^^^^^^^^^^^^^^^^ Returns the text surrounded by double quotes. +.. _command-format-replace: -.. _command-replace: - -replace -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +format replace +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Replaces all non-overlapping occurrences of ** with ** in **. +.. _command-format-field: -.. _command-capitalize: +format field +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -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 +Returns the *th* space-separated field of **. I.e., if text is "foo bar baz" and ** is 2, "bar" is returned. +.. _command-format-concat: -.. _command-concat: - -concat -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +format 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-format-translate: -.. _command-translate: - -translate -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +format translate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Replaces ** with ** in **. The first and second arguments must necessarily be the same length. +.. _command-format-cut: + +format 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-format-join: + +format join [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Joins all the arguments together with **. + +.. _command-format-reverse: + +format reverse +^^^^^^^^^^^^^^^^^^^^^ + +Returns ** in reverse-video. + +Text properties +--------------- + +.. _command-format-bold: + +format bold +^^^^^^^^^^^^^^^^^^ + +Returns ** bolded. + +.. _command-format-underline: + +format underline +^^^^^^^^^^^^^^^^^^^^^^^ + +Returns ** underlined. diff --git a/use/plugins/games.rst b/use/plugins/games.rst index dc5bdc2..761a102 100644 --- a/use/plugins/games.rst +++ b/use/plugins/games.rst @@ -4,49 +4,49 @@ The Games plugin ================ -.. _command-dice: +Random +------ -dice d -^^^^^^^^^^^^^^^^^^^ +.. _command-games-dice: + +games 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-games-roulette: -.. _command-roulette: - -roulette [spin] -^^^^^^^^^^^^^^^ +games roulette [spin] +^^^^^^^^^^^^^^^^^^^^^ Fires the revolver. If the bullet was in the chamber, you're dead. Tell me to spin the chambers and I will. +.. _command-games-eightball: -.. _command-eightball: - -eightball [] -^^^^^^^^^^^^^^^^^^^^^^ +games eightball [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Ask a question and the answer shall be provided. +.. _command-games-coin: -.. _command-monologue: +games coin +^^^^^^^^^^ -monologue [] -^^^^^^^^^^^^^^^^^^^^^ +Flips a coin and returns the result. + +Miscellaneous +------------- + +.. _command-games-monologue: + +games 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 index fdf7d0b..9a1ec17 100644 --- a/use/plugins/google.rst +++ b/use/plugins/google.rst @@ -4,78 +4,64 @@ The Google plugin ================= -.. _command-google: +Web search +---------- -google [--{filter,language} ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-google-google: + +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-google-cache: -.. _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 -^^^^^^^^^^^ +google cache +^^^^^^^^^^^^^^^^^^ Returns a link to the cached version of ** if it is available. +.. _command-google-lucky: -.. _command-lucky: - -lucky [--snippet] -^^^^^^^^^^^^^^^^^^^^^^^^^^ +google lucky [--snippet] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Does a google search, but only returns the first result. If option *--snippet* is given, returns also the page text snippet. +.. _command-google-fight: -.. _command-fight: - -fight [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +google fight [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the results of each search, in order, from greatest number of results to least. +Others +------ -.. _command-phonebook: +.. _command-google-phonebook: -phonebook -^^^^^^^^^^^^^^^^^^^^^^^^ +google phonebook +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Looks ** up on Google. +.. _command-google-calc: -.. _command-calc: - -calc -^^^^^^^^^^^^^^^^^ +google calc +^^^^^^^^^^^^^^^^^^^^^^^^ Uses Google's calculator to calculate the value of **. +.. _command-google-translate: -.. _command-translate: - -translate [to] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +google 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 index 0314172..d0adbbc 100644 --- a/use/plugins/herald.rst +++ b/use/plugins/herald.rst @@ -4,28 +4,23 @@ The Herald plugin ================= -.. _command-get: +User commands +------------- -get [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-herald-get: + +herald 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-herald-remove: -.. _command-die: - -die -^^^^ - - - -.. _command-remove: - -remove [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +herald remove [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Removes the herald message set for **, or the user ** is currently identified or recognized as. If ** @@ -33,36 +28,35 @@ is not given, defaults to the user giving the command. ** is only necessary if the message isn't sent in the channel itself. +.. _command-herald-change: -.. _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 [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +herald 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. +Op commands +----------- + +.. _command-herald-default: + +herald 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-herald-add: + +herald 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. diff --git a/use/plugins/index.rst b/use/plugins/index.rst index 190d245..32a135c 100644 --- a/use/plugins/index.rst +++ b/use/plugins/index.rst @@ -10,5 +10,96 @@ Main plugins .. toctree:: :maxdepth: 3 - owner.rst admin.rst + channel.rst + config.rst + misc.rst + network.rst + owner.rst + plugin.rst + +Channel-specific plugins +======================== + +.. toctree:: + :maxdepth: 3 + + automode.rst + badwords.rst + channellogger.rst + channelstats.rst + factoids.rst + herald.rst + karma.rst + lart.rst + limiter.rst + moobotfactoids.rst + protector.rst + topic.rst + + +Utilities +========= + +.. toctree:: + :maxdepth: 3 + + anonymous.rst + ctcp.rst + later.rst + news.rst + nickcapture.rst + note.rst + relay.rst + rss.rst + seen.rst + services.rst + shrinkurl.rst + string.rst + +Internal tools +=============== + +.. toctree:: + :maxdepth: 3 + + alias.rst + conditional.rst + dunno.rst + format.rst + messageparser.rst + plugindownloader.rst + reply.rst + scheduler.rst + success.rst + utilities.rst + +Fun +=== + +.. toctree:: + :maxdepth: 3 + + filter.rst + games.rst + nickometer.rst + praise.rst + quote.rst + quotegrabs.rst + +Other plugins +============= + +.. toctree:: + :maxdepth: 3 + + dict.rst + google.rst + internet.rst + math.rst + status.rst + time.rst + todo.rst + unix.rst + url.rst + web.rst diff --git a/use/plugins/internet.rst b/use/plugins/internet.rst index 9908d4c..12b5716 100644 --- a/use/plugins/internet.rst +++ b/use/plugins/internet.rst @@ -4,27 +4,24 @@ The Internet plugin =================== -.. _command-whois: +.. _command-internet-whois: -whois -^^^^^^^^^^^^^^ +internet whois +^^^^^^^^^^^^^^^^^^^^^^^ Returns WHOIS information on the registration of **. +.. _command-internet-dns: -.. _command-dns: - -dns -^^^^^^^^^^^^^ +internet dns +^^^^^^^^^^^^^^^^^^^^^^ Returns the ip of ** or the reverse DNS hostname of **. +.. _command-internet-hexip: -.. _command-hexip: - -hexip -^^^^^^^^^^ +internet hexip +^^^^^^^^^^^^^^^^^^^ Returns the hexadecimal IP for that IP. - diff --git a/use/plugins/karma.rst b/use/plugins/karma.rst index 5cad1b3..aa5d461 100644 --- a/use/plugins/karma.rst +++ b/use/plugins/karma.rst @@ -4,61 +4,55 @@ The Karma plugin ================ -.. _command-load: +Main commands +------------- -load [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-karma-clear: -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 [] -^^^^^^^^^^^^^^^^^^^^^^^^ +karma clear [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Resets the karma of ** to 0. +.. _command-karma-most: -.. _command-most: - -most [] {increased,decreased,active} -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +karma 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: -.. _command-karma: - -karma [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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 +:ref:`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. +Maintenance +----------- + +.. _command-karma-load: + +karma 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-karma-dump: + +karma 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. diff --git a/use/plugins/lart.rst b/use/plugins/lart.rst index 58aeb62..ce923a9 100644 --- a/use/plugins/lart.rst +++ b/use/plugins/lart.rst @@ -4,13 +4,12 @@ The Lart plugin =============== -.. _command-lart: +.. _command-lart-lart: -lart [] [] [for ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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 index a705ad9..0e5837e 100644 --- a/use/plugins/later.rst +++ b/use/plugins/later.rst @@ -4,37 +4,27 @@ The Later plugin ================ -.. _command-die: +.. _command-later-notes: -die -^^^^ - - - -.. _command-notes: - -notes [] -^^^^^^^^^^^^^^ +later notes [] +^^^^^^^^^^^^^^^^^^^^ If ** is given, replies with what notes are waiting on **, otherwise, replies with the nicks that have notes waiting for them. +.. _command-later-remove: -.. _command-remove: - -remove -^^^^^^^^^^^^^ +later remove +^^^^^^^^^^^^^^^^^^^ Removes the notes waiting on **. +.. _command-later-tell: -.. _command-tell: - -tell -^^^^^^^^^^^^^^^^^^ +later 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/math.rst b/use/plugins/math.rst index 38b3b0a..65ac352 100644 --- a/use/plugins/math.rst +++ b/use/plugins/math.rst @@ -4,56 +4,57 @@ The Math plugin =============== -.. _command-base: +Conversion +---------- -base [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-math-base: + +math base [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Converts ** from base ** to base **. If ** is left out, it converts to decimal. +.. _command-math-convert: -.. _command-rpn: - -rpn -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the value of an RPN expression. - - -.. _command-convert: - -convert [] to -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +math convert [] to +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Converts from ** to **. If number isn't given, it defaults to 1. For unit information, see 'units' command. +Calculation +----------- -.. _command-icalc: +.. _command-math-rpn: -icalc -^^^^^^^^^^^^^^^^^^^^^^^ +math rpn +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the value of an RPN expression. + +.. _command-math-icalc: + +math 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-math-units: -.. _command-units: - -units [] -^^^^^^^^^^^^^^ +math 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-math-calc: -.. _command-calc: - -calc -^^^^^^^^^^^^^^^^^^^^^^ +math calc +^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the value of the evaluated **. The syntax is Python syntax; the type of arithmetic is floating point. Floating @@ -61,4 +62,3 @@ 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 index 09ae941..bd32199 100644 --- a/use/plugins/messageparser.rst +++ b/use/plugins/messageparser.rst @@ -4,52 +4,52 @@ The MessageParser plugin ======================== -.. _command-show: +Administration +-------------- -show [] [--id] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-messageparser-remove: -Looks up the value of ** in the triggers database. -** is only necessary if the message isn't sent in the channel -itself. +messageparser 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-messageparser-add: -.. _command-lock: +messageparser add [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -lock [] -^^^^^^^^^^^^^^^^^^^^^^^^^ +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. + + +.. _command-messageparser-lock: + +messageparser 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-messageparser-unlock: -.. _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 [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +messageparser 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-messageparser-vacuum: -.. _command-vacuum: - -vacuum [] -^^^^^^^^^^^^^^^^^^ +messageparser vacuum [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Vacuums the database for **. See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html @@ -58,46 +58,44 @@ the channel itself. First check if user has the required capability specified in plugin config requireVacuumCapability. +User commands +------------- -.. _command-info: +.. _command-messageparser-show: -info [] [--id] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +messageparser 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-messageparser-rank: + +messageparser 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-messageparser-info: + +messageparser 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-messageparser-list: -.. _command-list: - -list [] -^^^^^^^^^^^^^^^^ +messageparser 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 index 1f4a94e..e20a532 100644 --- a/use/plugins/misc.rst +++ b/use/plugins/misc.rst @@ -4,10 +4,43 @@ The Misc plugin =============== -.. _command-last: +Main commands +------------- -last [--{from,in,on,with,without,regexp} ] [--nolimit] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-misc-help: + +misc help [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This command gives a useful description of what ** does. +** is only necessary if the command is in more than one plugin. + +.. _command-misc-list: + +misc 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-misc-more: + +misc 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. + +Utilities +--------- + +.. _command-misc-last: + +misc 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 @@ -17,76 +50,42 @@ a regular expression the message must match; *--nolimit* returns all the messages that can be found. By default, the channel this command is given in is searched. +.. _command-misc-ping: -.. _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 -^^^^ +misc ping +^^^^^^^^^ Checks to see if the bot is alive. +.. _command-misc-tell: -.. _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 -^^^^^^^^^^^^^^^^^^ +misc tell +^^^^^^^^^^^^^^^^^^^^^^^ Tells the ** whatever ** is. Use nested commands to your benefit here. +Getting informations about the bot +---------------------------------- -.. _command-more: +.. _command-misc-source: -more [] -^^^^^^^^^^^^^ +misc source +^^^^^^^^^^^ -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. +Returns a URL saying where to get Supybot. +.. _command-misc-version: +misc version +^^^^^^^^^^^^ + +Returns the version of the current bot. + +.. _command-misc-apropos: + +misc apropos +^^^^^^^^^^^^^^^^^^^^^ + +Searches for ** in the commands currently offered by the bot, +returning a list of the commands containing that string. diff --git a/use/plugins/moobotfactoids.rst b/use/plugins/moobotfactoids.rst index 14a3a5f..df916e9 100644 --- a/use/plugins/moobotfactoids.rst +++ b/use/plugins/moobotfactoids.rst @@ -4,119 +4,101 @@ The MoobotFactoids plugin ========================= -.. _command-lock: +Reading factoids +---------------- -lock [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-moobotfactoids-listauth: -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 [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +moobotfactoids 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-moobotfactoids-random: -.. _command-random: - -random [] -^^^^^^^^^^^^^^^^^^ +moobotfactoids 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-moobotfactoids-literal: -.. _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 [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +moobotfactoids 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-moobotfactoids-listvalues: -.. _command-listvalues: - -listvalues [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +moobotfactoids 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-moobotfactoids-factinfo: -.. _command-reset: - -reset -^^^^^^ - - - -.. _command-factinfo: - -factinfo [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +moobotfactoids 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-moobotfactoids-most: -.. _command-most: +moobotfactoids most [] {popular|authored|recent} +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -most [] {popular|authored|recent} -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Lists the most {popular|authored|recent} factoids. "popular" lists the +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-moobotfactoids-listkeys: -.. _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 [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +moobotfactoids 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. +Administration +-------------- + +.. _command-moobotfactoids-lock: + +moobotfactoids 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-moobotfactoids-unlock: + +moobotfactoids 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-moobotfactoids-remove: + +moobotfactoids remove [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Deletes the factoid with the given key. ** 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 index 6769197..db31087 100644 --- a/use/plugins/network.rst +++ b/use/plugins/network.rst @@ -4,20 +4,60 @@ The Network plugin ================== -.. _command-driver: +Getting status +-------------- -driver [] -^^^^^^^^^^^^^^^^^^ +.. _command-network-driver: + +network 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-network-networks: -.. _command-connect: +network networks +^^^^^^^^^^^^^^^^ -connect [--ssl] [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Returns the networks to which the bot is currently connected. + +.. _command-network-latency: + +network 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. + +Running commands +---------------- + +.. _command-network-whois: + +network whois [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns the WHOIS response ** gives for **. ** is +only necessary if the network is different than the network the command +is sent on. + +.. _command-network-command: + +network command [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Gives the bot ** (with its associated **s) on **. + +(Dis)connecting +--------------- + +.. _command-network-connect: + +network connect [--ssl] [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Connects to another network (which will be represented by the name provided in **) at **. If port is not provided, it @@ -25,63 +65,23 @@ defaults to 6667, the default port for IRC. If password is provided, it will be sent to the server in a PASS command. If *--ssl* is provided, an SSL connection will be attempted. +.. _command-network-reconnect: -.. _command-reconnect: - -reconnect [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +network 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 +(:ref:`supybot.plugins.Owner.quitMsg`) or the nick of the person giving the command. +.. _command-network-disconnect: -.. _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 [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +network 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 index 6c30f54..09ac945 100644 --- a/use/plugins/news.rst +++ b/use/plugins/news.rst @@ -4,62 +4,56 @@ The News plugin =============== -.. _command-old: +Read news +--------- -old [] [] -^^^^^^^^^^^^^^^^^^^^^^ +.. _command-news-old: + +news 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-news-news: -.. _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 [] [] -^^^^^^^^^^^^^^^^^^^^^^^ +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. +Administration +-------------- -.. _command-change: +.. _command-news-remove: -change [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +news remove [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Removes the news item with ** from **. ** is only +necessary if the message isn't sent in the channel itself. + +.. _command-news-add: + +news 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-change: + +news 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/nickometer.rst b/use/plugins/nickometer.rst index 0ddc320..4606fd5 100644 --- a/use/plugins/nickometer.rst +++ b/use/plugins/nickometer.rst @@ -4,19 +4,11 @@ The Nickometer plugin ===================== -.. _command-punish: +.. _command-nickometer-nickometer: -punish -^^^^^^^ - - - -.. _command-nickometer: - -nickometer [] -^^^^^^^^^^^^^^^^^^^ +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 index b609bb6..2f08a91 100644 --- a/use/plugins/note.rst +++ b/use/plugins/note.rst @@ -4,74 +4,66 @@ The Note plugin =============== -.. _command-unsend: +Reading notes +------------- -unsend -^^^^^^^^^^^ +.. _command-note-search: -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] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +note 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-note-list: -.. _command-reply: - -reply -^^^^^^^^^^^^^^^^^ - -Sends a note in reply to **. - - -.. _command-die: - -die -^^^^ - - - -.. _command-list: - -list [--{old,sent}] [--{from,to} ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +note 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-note-next: -.. _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 -^^^^ +note next +^^^^^^^^^ Retrieves your next unread note, if any. +.. _command-note-note: -.. _command-note: - -note -^^^^^^^^^ +note note +^^^^^^^^^^^^^^ Retrieves a single note by its unique note id. Use the 'note list' command to see what unread notes you have. +Sending notes +------------- + +.. _command-note-unsend: + +note unsend +^^^^^^^^^^^^^^^^ + +Unsends the note with the id given. You must be the +author of the note, and it must be unread. + +.. _command-note-reply: + +note reply +^^^^^^^^^^^^^^^^^^^^^^ + +Sends a note in reply to **. + +.. _command-note-send: + +note send ,[,[...]] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sends a new note to the user specified. Multiple recipients may be +specified by separating their names by commas. diff --git a/use/plugins/owner.rst b/use/plugins/owner.rst index a6fb860..b735acb 100644 --- a/use/plugins/owner.rst +++ b/use/plugins/owner.rst @@ -4,64 +4,64 @@ The Owner plugin ================ -.. _command-load: +Plugins and commands +-------------------- -load [--deprecated] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-owner-load: + +owner load [--deprecated] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Loads the plugin ** from any of the directories in -conf.supybot.directories.plugins; usually this includes the main +conf.:ref:`supybot.directories.plugins`; usually this includes the main installed directory and 'plugins' in the current directory. *--deprecated* is necessary if you wish to load deprecated plugins. +.. _command-owner-unload: -.. _command-rename: +owner unload +^^^^^^^^^^^^^^^^^^^^^ -rename -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Unloads the callback by name; use the 'list' command to see a list +of the currently loaded callbacks. Obviously, the Owner plugin can't +be unloaded. + +.. _command-owner-reload: + +owner reload +^^^^^^^^^^^^^^^^^^^^^ + +Unloads and subsequently reloads the plugin by name; use the 'list' +command to see a list of the currently loaded plugins. + +.. _command-owner-rename: + +owner rename +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Renames ** in ** to the **. +.. _command-owner-unrename: -.. _command-enable: +owner unrename +^^^^^^^^^^^^^^^^^^^^^^^ -enable [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Removes all renames in **. The plugin will be reloaded after +this command is run. + +.. _command-owner-enable: + +owner enable [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Enables the command ** for all users. If ** if given, only enables the ** from **. This command is the inverse of disable. +.. _command-owner-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 [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +owner disable [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Disables the command ** for all users (including the owners). If ** is given, only disables the ** from **. If @@ -69,98 +69,85 @@ you want to disable a command for most users but not for yourself, set a default capability of -plugin.command or -command (if you want to disable the command in all plugins). +.. _command-owner-defaultplugin: -.. _command-upkeep: +owner defaultplugin [--remove] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -upkeep [] -^^^^^^^^^^^^^^^^ +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, :ref:`supybot.commands.defaultPlugins.importantPlugins.` + +Capabilities +------------ + +.. _command-owner-defaultcapability: + +owner defaultcapability {add|remove} +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Adds or removes (according to the first argument) ** from the +default capabilities given to users (the configuration variable +:ref:`supybot.capabilities` stores these). + +Maintenance +----------- + +.. _command-owner-reloadlocale: + +owner reloadlocale takes no argument +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Reloads the locale of the bot. + +.. _command-owner-ircquote: + +owner ircquote +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Sends the raw string given to the server. + +.. _command-owner-upkeep: + +owner 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-owner-flush: -.. _command-flush: - -flush -^^^^^ +owner flush +^^^^^^^^^^^ Runs all the periodic flushers in world.flushers. This includes flushing all logs and all configuration changes to disk. +.. _command-owner-quit: -.. _command-unrename: - -unrename -^^^^^^^^^^^^^^^^^ - -Removes all renames in **. The plugin will be reloaded after -this command is run. - - -.. _command-reset: - -reset -^^^^^^ - - - -.. _command-quit: - -quit [] -^^^^^^^^^^^^^ +owner quit [] +^^^^^^^^^^^^^^^^^^^ Exits the bot with the QUIT message **. If ** is not given, -the default quit message (supybot.plugins.Owner.quitMsg) will be used. +the default quit message (:ref:`supybot.plugins.Owner.quitMsg`) will be used. If there is no default quitMsg set, your nick will be used. +.. _command-owner-announce: -.. _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 -^^^^^^^^^^^^^^^ +owner announce +^^^^^^^^^^^^^^^^^^^^^ Sends ** to all channels the bot is currently on and not lobotomized in. +.. _command-owner-logmark: -.. _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 -^^^^^^^^^^^^^^ +owner 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 index 0f55b16..e5ab542 100644 --- a/use/plugins/plugin.rst +++ b/use/plugins/plugin.rst @@ -4,59 +4,59 @@ The Plugin plugin ================= -.. _command-help: +Authorship +---------- -help -^^^^^^^^^^^^^ +.. _command-plugin-contributors: -Returns a useful description of how to use **, if the plugin has -one. - - -.. _command-contributors: - -contributors [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +plugin 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-author: -.. _command-plugin: +plugin author +^^^^^^^^^^^^^^^^^^^^^^ -plugin -^^^^^^^^^^^^^^^^ +Returns the author of **. This is the person you should talk to +if you have ideas, suggestions, or other comments about a given plugin. + +Help +---- + +.. _command-plugin-help: + +plugin help +^^^^^^^^^^^^^^^^^^^^ + +Returns a useful description of how to use **, if the plugin has +one. + +.. _command-plugin-plugin: + +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-plugin-list: -.. _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 -^^^^ +plugin list +^^^^^^^^^^^ Returns a list of the currently loaded plugins. +.. _command-plugin-plugins: -.. _command-plugins: - -plugins -^^^^^^^^^^^^^^^^^ +plugin plugins +^^^^^^^^^^^^^^^^^^^^^^^^ Returns the names of all plugins that contain **. - diff --git a/use/plugins/plugindownloader.rst b/use/plugins/plugindownloader.rst index c6d539a..53ce6e0 100644 --- a/use/plugins/plugindownloader.rst +++ b/use/plugins/plugindownloader.rst @@ -4,17 +4,17 @@ The PluginDownloader plugin =========================== -.. _command-install: +.. _command-plugindownloader-install: -install -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +plugindownloader install +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Downloads and installs the ** from the **. -.. _command-repolist: +.. _command-plugindownloader-repolist: -repolist [] -^^^^^^^^^^^^^^^^^^^^^^^ +plugindownloader repolist [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Displays the list of plugins in the **. If ** is not given, returns a list of available diff --git a/use/plugins/praise.rst b/use/plugins/praise.rst index 8225641..9aa47dc 100644 --- a/use/plugins/praise.rst +++ b/use/plugins/praise.rst @@ -4,13 +4,12 @@ The Praise plugin ================= -.. _command-praise: +.. _command-praise-praise: -praise [] [] [for ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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 index 4c022d6..517b8f0 100644 --- a/use/plugins/protector.rst +++ b/use/plugins/protector.rst @@ -4,10 +4,3 @@ The Protector plugin ==================== -.. _command-demote: - -demote -^^^^^^^ - - - diff --git a/use/plugins/quote.rst b/use/plugins/quote.rst index fa85be1..7719481 100644 --- a/use/plugins/quote.rst +++ b/use/plugins/quote.rst @@ -4,12 +4,11 @@ The Quote plugin ================ -.. _command-random: +.. _command-quote-random: -random [] -^^^^^^^^^^^^^^^^^^ +quote 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 index 1a3c419..a7c46bc 100644 --- a/use/plugins/quotegrabs.rst +++ b/use/plugins/quotegrabs.rst @@ -4,71 +4,70 @@ The QuoteGrabs plugin ===================== -.. _command-ungrab: +Getting quotes +-------------- -ungrab [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-quotegrabs-get: -Removes the grab ** (the last by default) on **. -** is only necessary if the message isn't sent in the channel -itself. - - -.. _command-get: - -get [] -^^^^^^^^^^^^^^^^^^^^ +quotegrabs get [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Return the quotegrab with the given **. ** is only necessary if the message isn't sent in the channel itself. +.. _command-quotegrabs-quote: -.. _command-quote: - -quote [] -^^^^^^^^^^^^^^^^^^^^^^^^ +quotegrabs quote [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns **'s latest quote grab in **. ** is only necessary if the message isn't sent in the channel itself. +.. _command-quotegrabs-random: -.. _command-random: - -random [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +quotegrabs 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-quotegrabs-list: -.. _command-list: - -list [] -^^^^^^^^^^^^^^^^^^^^^^^ +quotegrabs 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-quotegrabs-search: -.. _command-search: - -search [] -^^^^^^^^^^^^^^^^^^^^^^^^^ +quotegrabs search [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Searches for ** in a quote. ** is only necessary if the message isn't sent in the channel itself. +(Un)quoting +----------- -.. _command-grab: +.. _command-quotegrabs-ungrab: -grab [] -^^^^^^^^^^^^^^^^^^^^^^^ +quotegrabs ungrab [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Removes the grab ** (the last by default) on **. +** is only necessary if the message isn't sent in the channel +itself. + +.. _command-quotegrabs-grab: + +quotegrabs 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 index fd2a962..19de1c7 100644 --- a/use/plugins/relay.rst +++ b/use/plugins/relay.rst @@ -4,30 +4,28 @@ The Relay plugin ================ -.. _command-nicks: +.. _command-relay-nicks: -nicks [] -^^^^^^^^^^^^^^^^^ +relay 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-relay-part: -.. _command-part: - -part -^^^^^^^^^^^^^^ +relay 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-relay-join: -.. _command-join: - -join [] -^^^^^^^^^^^^^^^^ +relay join [] +^^^^^^^^^^^^^^^^^^^^^^ Starts relaying between the channel ** on all networks. If on a network the bot isn't in **, he'll join. This commands is @@ -36,4 +34,3 @@ 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 index b58ebd7..3ac81fd 100644 --- a/use/plugins/reply.rst +++ b/use/plugins/reply.rst @@ -4,47 +4,42 @@ The Reply plugin ================ -.. _command-notice: +.. _command-reply-notice: -notice -^^^^^^^^^^^^^ +reply notice +^^^^^^^^^^^^^^^^^^^ Replies with ** in a notice. Use nested commands to your benefit here. If you want a private notice, nest the private command. +.. _command-reply-private: -.. _command-private: - -private -^^^^^^^^^^^^^^ +reply private +^^^^^^^^^^^^^^^^^^^^ Replies with ** in private. Use nested commands to your benefit here. +.. _command-reply-replies: -.. _command-replies: - -replies [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^ +reply replies [ ...] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Replies with each of its arguments ** in separate replies, depending -the configuration of supybot.reply.oneToOne. +the configuration of :ref:`supybot.reply.oneToOne.` +.. _command-reply-action: -.. _command-action: - -action -^^^^^^^^^^^^^ +reply action +^^^^^^^^^^^^^^^^^^^ Replies with ** as an action. use nested commands to your benefit here. +.. _command-reply-reply: -.. _command-reply: - -reply -^^^^^^^^^^^^ +reply reply +^^^^^^^^^^^^^^^^^^ Replies with **. Equivalent to the alias, 'echo $nick: $1'. - diff --git a/use/plugins/rss.rst b/use/plugins/rss.rst index 67b7b4c..71c4450 100644 --- a/use/plugins/rss.rst +++ b/use/plugins/rss.rst @@ -4,70 +4,69 @@ The RSS plugin ============== -.. _command-info: +Reading +------- -info -^^^^^^^^^^^^^^^ +.. _command-rss-info: + +rss info +^^^^^^^^^^^^^^^^^^^ Returns information from the given RSS feed, namely the title, URL, description, and last update date, if available. +.. _command-rss-announce-list: -.. _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 [] -^^^^^^^^^^^^^^^^^^^^^^^^^ +rss announce list [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the list of feeds announced in **. ** is only necessary if the message isn't sent in the channel itself. +.. _command-rss-rss: -.. _command-announce-remove: +rss rss [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -announce remove [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Gets the title components of the given RSS feed. +If ** is given, return only that many headlines. + +Administration +-------------- + +.. _command-rss-remove: + +rss remove +^^^^^^^^^^^^^^^^^ + +Removes the command for looking up RSS feeds at ** from +this plugin. + +.. _command-rss-add: + +rss add +^^^^^^^^^^^^^^^^^^^^ + +Adds a command to this plugin that will look up the RSS feed at the +given URL. + +.. _command-rss-announce-remove: + +rss 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-rss-announce-add: -.. _command-announce-add: - -announce add [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +rss 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 index 49fb8f0..ce88fbe 100644 --- a/use/plugins/scheduler.rst +++ b/use/plugins/scheduler.rst @@ -4,36 +4,27 @@ The Scheduler plugin ==================== -.. _command-repeat: +.. _command-scheduler-repeat: -repeat -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +scheduler 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-scheduler-list: -.. _command-die: - -die -^^^^ - - - -.. _command-list: - -list -^^^^ +scheduler list +^^^^^^^^^^^^^^ Lists the currently scheduled events. +.. _command-scheduler-add: -.. _command-add: - -add -^^^^^^^^^^^^^^^^^^^^^^^ +scheduler add +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Schedules the command string ** to run ** seconds in the future. For example, 'scheduler add [seconds 30m] "echo [cpu]"' will @@ -41,12 +32,10 @@ schedule the command "cpu" to be sent to the channel the schedule add command was given in (with no prefixed nick, a consequence of using echo). Do pay attention to the quotes in that example. +.. _command-scheduler-remove: -.. _command-remove: - -remove -^^^^^^^^^^^ +scheduler remove +^^^^^^^^^^^^^^^^^^^^^ Removes the event scheduled with id ** from the schedule. - diff --git a/use/plugins/seen.rst b/use/plugins/seen.rst index 5955870..5788407 100644 --- a/use/plugins/seen.rst +++ b/use/plugins/seen.rst @@ -4,10 +4,10 @@ The Seen plugin =============== -.. _command-user: +.. _command-seen-user: -user [] -^^^^^^^^^^^^^^^^^^^^^^^ +seen user [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the last time ** was seen and what ** was last seen saying. This looks up ** in the user seen database, which means @@ -15,21 +15,19 @@ 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: -.. _command-seen: - -seen [] -^^^^^^^^^^^^^^^^^^^^^^^ +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-seen-any: -.. _command-any: - -any [] [--user ] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +seen any [] [--user ] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the last time ** was seen and what ** was last seen doing. This includes any form of activity, instead of just PRIVMSGs. @@ -38,28 +36,18 @@ If ** isn't specified, returns the last activity seen in and returns the last time user was active in **. ** is only necessary if the message isn't sent on the channel itself. +.. _command-seen-last: -.. _command-last: - -last [] -^^^^^^^^^^^^^^^^ +seen last [] +^^^^^^^^^^^^^^^^^^^^^ Returns the last thing said in **. ** is only necessary if the message isn't sent in the channel itself. +.. _command-seen-since: -.. _command-die: - -die -^^^^ - - - -.. _command-since: - -since [] -^^^^^^^^^^^^^^^^^^^^^^^^ +seen since [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the messages since ** last left the channel. - diff --git a/use/plugins/services.rst b/use/plugins/services.rst index 980feb7..bdc999c 100644 --- a/use/plugins/services.rst +++ b/use/plugins/services.rst @@ -4,92 +4,76 @@ The Services plugin =================== -.. _command-disabled: +NickServ +-------- -disabled -^^^^^^^^^ +.. _command-services-identify: - - -.. _command-identify: - -identify -^^^^^^^^ +services identify +^^^^^^^^^^^^^^^^^ Identifies with NickServ using the current nick. +.. _command-services-nicks: -.. _command-nicks: - -nicks -^^^^^ +services nicks +^^^^^^^^^^^^^^ Returns the nicks that this plugin is configured to identify and ghost with. +.. _command-services-password: -.. _command-unban: +services password [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -unban [] -^^^^^^^^^^^^^^^^^ +Sets the NickServ password for ** to **. If ** is +not given, removes ** from the configured nicks. + +.. _command-services-ghost: + +services ghost [] +^^^^^^^^^^^^^^^^^^^^^^^ + +Ghosts the bot's given nick and takes it. If no nick is given, +ghosts the bot's configured nick and takes it. + +ChanServ +-------- + +.. _command-services-unban: + +services unban [] +^^^^^^^^^^^^^^^^^^^^^^^^^^ 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-services-invite: -.. _command-reset: - -reset -^^^^^^ - - - -.. _command-invite: - -invite [] -^^^^^^^^^^^^^^^^^^ +services 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-services-voice: -.. _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 [] -^^^^^^^^^^^^^^^^^ +services voice [] +^^^^^^^^^^^^^^^^^^^^^^^^^^ Attempts to get voiced by ChanServ in **. ** is only necessary if the message isn't sent in the channel itself. +.. _command-services-op: -.. _command-op: - -op [] -^^^^^^^^^^^^^^ +services 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 index 81f6f52..1159dd4 100644 --- a/use/plugins/shrinkurl.rst +++ b/use/plugins/shrinkurl.rst @@ -4,34 +4,24 @@ The ShrinkUrl plugin ==================== -.. _command-xrl: +.. _command-shrinkurl-xrl: -xrl -^^^^^^^^^ +shrinkurl xrl +^^^^^^^^^^^^^^^^^^^ Returns an xrl.us version of **. +.. _command-shrinkurl-tiny: -.. _command-die: - -die -^^^^ - - - -.. _command-tiny: - -tiny -^^^^^^^^^^ +shrinkurl tiny +^^^^^^^^^^^^^^^^^^^^ Returns a TinyURL.com version of ** +.. _command-shrinkurl-ln: -.. _command-ln: - -ln -^^^^^^^^ +shrinkurl ln +^^^^^^^^^^^^^^^^^^ Returns an ln-s.net version of **. - diff --git a/use/plugins/status.rst b/use/plugins/status.rst index 85c1227..de1126a 100644 --- a/use/plugins/status.rst +++ b/use/plugins/status.rst @@ -4,67 +4,59 @@ The Status plugin ================= -.. _command-status: +.. _command-status-status: -status -^^^^^^ +status status +^^^^^^^^^^^^^ Returns the status of the bot. +.. _command-status-cmd: -.. _command-cmd: - -cmd -^^^ +status cmd +^^^^^^^^^^ Returns some interesting command-related statistics. +.. _command-status-commands: -.. _command-commands: - -commands -^^^^^^^^ +status commands +^^^^^^^^^^^^^^^ Returns a list of the commands offered by the bot. +.. _command-status-uptime: -.. _command-uptime: - -uptime -^^^^^^ +status uptime +^^^^^^^^^^^^^ Returns the amount of time the bot has been running. +.. _command-status-threads: -.. _command-threads: - -threads -^^^^^^^ +status threads +^^^^^^^^^^^^^^ Returns the current threads that are active. +.. _command-status-net: -.. _command-net: - -net -^^^ +status net +^^^^^^^^^^ Returns some interesting network-related statistics. +.. _command-status-server: -.. _command-server: - -server -^^^^^^ +status server +^^^^^^^^^^^^^ Returns the server the bot is on. +.. _command-status-cpu: -.. _command-cpu: - -cpu -^^^ +status cpu +^^^^^^^^^^ Returns some interesting CPU-related statistics on the bot. - diff --git a/use/plugins/string.rst b/use/plugins/string.rst index 63c2c18..3cc33f4 100644 --- a/use/plugins/string.rst +++ b/use/plugins/string.rst @@ -4,97 +4,96 @@ The String plugin ================= -.. _command-soundex: +Hashes +------ -soundex [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-string-soundex: + +string 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-string-sha: -.. _command-xor: +string sha +^^^^^^^^^^^^^^^^^ -xor -^^^^^^^^^^^^^^^^^^^^^ +Returns the SHA hash of a given string. Read +http://www.secure-hash-algorithm-md5-sha-1.co.uk/ for more information +about SHA. + +Encoding/decoding +----------------- + +.. _command-string-xor: + +string xor +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns ** XOR-encrypted with **. See http://www.yoe.org/developer/xor.html for information about XOR encryption. +.. _command-string-encode: -.. _command-re: +string encode +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -re -^^^^^^^^^^^^^^^^^^ +Returns an encoded form of the given text; the valid encodings are +available in the documentation of the Python codecs module: +**. + +.. _command-string-decode: + +string decode +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Returns an un-encoded form of the given text; the valid encodings are +available in the documentation of the Python codecs module: +**. + +.. _command-string-ord: + +string ord +^^^^^^^^^^^^^^^^^^^ + +Returns the 8-bit value of **. + +.. _command-string-chr: + +string chr +^^^^^^^^^^^^^^^^^^^ + +Returns the character associated with the 8-bit value ** + +Miscellaneous +------------- + +.. _command-string-re: + +string 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-string-levenshtein: -.. _command-levenshtein: - -levenshtein -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +string levenshtein +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the levenshtein distance (also known as the "edit distance" between ** and **) +.. _command-string-len: -.. _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 -^^^^^^^^^^ +string 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 index 5f441c1..bee6955 100644 --- a/use/plugins/success.rst +++ b/use/plugins/success.rst @@ -4,10 +4,3 @@ The Success plugin ================== -.. _command-die: - -die -^^^^ - - - diff --git a/use/plugins/time.rst b/use/plugins/time.rst index 62020e1..28c431d 100644 --- a/use/plugins/time.rst +++ b/use/plugins/time.rst @@ -4,19 +4,47 @@ The Time plugin =============== -.. _command-ctime: +Relative time +------------- -ctime [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _command-time-ctime: + +time ctime [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the ctime for **, or the current ctime if no ** is given. +.. _command-time-time: -.. _command-seconds: +time time [] [] +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -seconds [y] [w] [d] [h] [m] [s] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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-time-elapsed: + +time elapsed +^^^^^^^^^^^^^^^^^^^^^^ + +Returns a pretty string that is the amount of time represented by +**. + +time until