Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2025-02-17 05:50:55 +01:00
Code Issues Projects Releases Wiki Activity

Review and update the layout.

Browse Source
This commit is contained in:
Valentin Lorentz 2011-06-28 17:29:38 +02:00
parent 2ce465adcd
commit b17bd0fac6
63 changed files with 2384 additions and 2323 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
commit.sh Executable file
View File

@ -0,0 +1,7 @@
make html
git commit "$@"
cd _build/html
git add .
git commit "$@"
git push
cd ../..

8
conf.py
View File

@ -41,7 +41,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Limnoria' 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 # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |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. # The short X.Y version.
version = '0.83' version = '0.83'
# The full version, including alpha/beta/rc tags. # 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 # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -179,7 +179,7 @@ htmlhelp_basename = 'Limnoriadoc'
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'Limnoria.tex', u'Limnoria Documentation', ('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 # 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). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'limnoria', u'Limnoria Documentation', ('index', 'limnoria', u'Limnoria Documentation',
[u'Valentin Lorentz'], 1) [u'The Limnoria/Gribble/Supybot contributors'], 1)
] ]

0
conf/channels.conf Normal file
View File

0
conf/ignores.conf Normal file
View File

0
conf/userdata.conf Normal file
View File

0
conf/users.conf Normal file
View File

18
generate_plugin_doc.py
View File

@ -17,29 +17,33 @@ def main():
supybot = __import__('supybot.plugins.%s.plugin' % pluginName) supybot = __import__('supybot.plugins.%s.plugin' % pluginName)
PluginClass = getattr(supybot.plugins, pluginName).plugin.Class PluginClass = getattr(supybot.plugins, pluginName).plugin.Class
filename = 'use/plugins/%s.rst' % pluginName.lower() filename = 'use/plugins/%s.rst' % pluginName.lower()
os.unlink(filename) try:
os.unlink(filename)
except OSError:
pass
with open(filename, 'a') as fd: with open(filename, 'a') as fd:
fd.write('\n.. _plugin-%s:\n\nThe %s plugin\n' % fd.write('\n.. _plugin-%s:\n\nThe %s plugin\n' %
(pluginName.lower(), pluginName)) (pluginName.lower(), pluginName))
fd.write('='*len('The %s plugin' % pluginName)) fd.write('='*len('The %s plugin' % pluginName))
fd.write('\n\n') fd.write('\n\n')
writeDoc(PluginClass, fd, '') writeDoc(PluginClass, fd, pluginName.lower())
def writeDoc(PluginClass, fd, prefix): def writeDoc(PluginClass, fd, prefix):
if prefix != '': prefix += ' '
prefix += ' '
for attributeName, attribute in PluginClass.__dict__.items(): for attributeName, attribute in PluginClass.__dict__.items():
if not callable(attribute): if not callable(attribute):
continue continue
if not validCommandName.match(attributeName): if not validCommandName.match(attributeName):
continue continue
if attributeName == 'die':
continue
if isinstance(attribute, Commands): if isinstance(attribute, Commands):
writeDoc(attribute, fd, prefix + attributeName) writeDoc(attribute, fd, prefix + attributeName)
else: else:
if attribute.__doc__ is None: if attribute.__doc__ is None:
attribute.__doc__ = '' attribute.__doc__ = ''
syntax = attribute.__doc__.split('\n\n')[0].strip() syntax = attribute.__doc__.split('\n\n')[0].strip()
if syntax == 'takes no arguments': if syntax == 'takes no arguments' or syntax == '' or syntax == '':
syntax = '' syntax = ''
else: else:
syntax = ' ' + syntax syntax = ' ' + syntax
@ -62,9 +66,13 @@ def parseHelpString(string):
string = '\n\n'.join(string.split('\n\n')[1:]) string = '\n\n'.join(string.split('\n\n')[1:])
# Remove the starting and ending spaces # Remove the starting and ending spaces
string = '\n'.join([x.strip(' ') for x in string.split('\n')]) 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 # Put the argument names into italic
string = re.sub(r'(<[^>]+>)', r'*\1*', string, re.M) string = re.sub(r'(<[^>]+>)', r'*\1*', string, re.M)
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 return string

289
logs/messages.log Normal file
View File

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

75
use/plugins/admin.rst
View File

@ -4,7 +4,29 @@
The Admin plugin The Admin plugin
================ ================
.. _command-channels: Capabilities
------------
.. _command-channel-capability-add:
capability add <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the user specified by *<name>* (or the user to whom *<hostmask>*
currently maps) the specified capability *<capability>*
.. _command-channel-capability-remove:
capability remove <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Takes from the user specified by *<name>* (or the user to whom
*<hostmask>* currently maps) the specified capability *<capability>*
Channels
--------
.. _command-channel-channels:
channels channels
^^^^^^^^ ^^^^^^^^
@ -12,8 +34,15 @@ channels
Returns the channels the bot is on. Must be given in private, in order Returns the channels the bot is on. Must be given in private, in order
to protect the secrecy of secret channels. to protect the secrecy of secret channels.
.. _command-channel-join:
.. _command-part: join <channel> [<key>]
^^^^^^^^^^^^^^^^^^^^^^
Tell the bot to join the given channel. If *<key>* is given, it is used
when attempting to join the channel.
.. _command-channel-part:
part [<channel>] [<reason>] part [<channel>] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -23,16 +52,17 @@ only necessary if you want the bot to part a channel other than the
current channel. If *<reason>* is specified, use it as the part current channel. If *<reason>* is specified, use it as the part
message. message.
Ignores
-------
.. _command-ignore-list: .. _command-channel-ignore-list:
ignore list ignore list
^^^^^^^^^^^ ^^^^^^^^^^^
Lists the hostmasks that the bot is ignoring. Lists the hostmasks that the bot is ignoring.
.. _command-channel-ignore-remove:
.. _command-ignore-remove:
ignore remove <hostmask|nick> ignore remove <hostmask|nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -40,8 +70,7 @@ ignore remove <hostmask|nick>
This will remove the persistent ignore on *<hostmask>* or the This will remove the persistent ignore on *<hostmask>* or the
hostmask currently associated with *<nick>*. hostmask currently associated with *<nick>*.
.. _command-channel-ignore-add:
.. _command-ignore-add:
ignore add <hostmask|nick> [<expires>] ignore add <hostmask|nick> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -51,35 +80,10 @@ currently associated with *<nick>*. *<expires>* is an optional argument
specifying when (in "seconds from now") the ignore will expire; if specifying when (in "seconds from now") the ignore will expire; if
it isn't given, the ignore will never automatically expire. it isn't given, the ignore will never automatically expire.
Miscellaneous
-------------
.. _command-join: .. _command-channel-nick:
join <channel> [<key>]
^^^^^^^^^^^^^^^^^^^^^^
Tell the bot to join the given channel. If *<key>* is given, it is used
when attempting to join the channel.
.. _command-capability-add:
capability add <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the user specified by *<name>* (or the user to whom *<hostmask>*
currently maps) the specified capability *<capability>*
.. _command-capability-remove:
capability remove <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Takes from the user specified by *<name>* (or the user to whom
*<hostmask>* currently maps) the specified capability *<capability>*
.. _command-nick:
nick [<nick>] nick [<nick>]
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
@ -87,4 +91,3 @@ nick [<nick>]
Changes the bot's nick to *<nick>*. If no nick is given, returns the Changes the bot's nick to *<nick>*. If no nick is given, returns the
bot's current nick. bot's current nick.

26
use/plugins/alias.rst
View File

@ -4,31 +4,27 @@
The Alias plugin The Alias plugin
================ ================
.. _command-lock: Protecting
----------
.. _command-channel-lock:
lock <alias> lock <alias>
^^^^^^^^^^^^ ^^^^^^^^^^^^
Locks an alias so that no one else can change it. Locks an alias so that no one else can change it.
.. _command-channel-unlock:
.. _command-unlock:
unlock <alias> unlock <alias>
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
Unlocks an alias so that people can define new aliases over it. Unlocks an alias so that people can define new aliases over it.
Adding and removing
-------------------
.. _command-remove: .. _command-channel-add:
remove <name>
^^^^^^^^^^^^^
Removes the given alias, if unlocked.
.. _command-add:
add <name> <alias> add <name> <alias>
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
@ -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 etc. can be used for optional arguments. $* simply means "all
remaining arguments," and cannot be combined with optional arguments. remaining arguments," and cannot be combined with optional arguments.
.. _command-channel-remove:
remove <name>
^^^^^^^^^^^^^
Removes the given alias, if unlocked.

8
use/plugins/anonymous.rst
View File

@ -4,20 +4,18 @@
The Anonymous plugin The Anonymous plugin
==================== ====================
.. _command-do: .. _command-channel-do:
do <channel> <action> do <channel> <action>
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
Performs *<action>* in *<channel>*. Performs *<action>* in *<channel>*.
.. _command-channel-say:
.. _command-say:
say <channel|nick> <text> say <channel|nick> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
Sends *<text>* to *<channel|nick>*. Can only send to *<nick>* if Sends *<text>* to *<channel|nick>*. Can only send to *<nick>* if
supybot.plugins.Anonymous.allowPrivateTarget is True. :ref:`supybot.plugins.Anonymous.allowPrivateTarget` is True.

20
use/plugins/badwords.rst
View File

@ -4,34 +4,24 @@
The BadWords plugin The BadWords plugin
=================== ===================
.. _command-sub: .. _command-channel-list:
sub
^^^^
.. _command-list:
list list
^^^^ ^^^^
Returns the list of words being censored. Returns the list of words being censored.
.. _command-channel-remove:
.. _command-remove:
remove <word> [<word> ...] remove <word> [<word> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes *<word>*s from the list of words being censored. Removes *<word>s* from the list of words being censored.
.. _command-channel-add:
.. _command-add:
add <word> [<word> ...] add <word> [<word> ...]
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
Adds all *<word>*s to the list of words being censored. Adds all *<word>s* to the list of words being censored.

458
use/plugins/channel.rst
View File

@ -4,35 +4,17 @@
The Channel plugin The Channel plugin
================== ==================
.. _command-unmoderate: Lobotomy
--------
unmoderate [<channel>] .. _command-channel-lobotomy-list:
^^^^^^^^^^^^^^^^^^^^^^
Sets -m on *<channel>*, making it so everyone can
send messages to the channel. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-devoice:
devoice [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove voice from all
the nicks given. If no nicks are given, removes voice from the person
sending the message.
.. _command-lobotomy-list:
lobotomy list lobotomy list
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
Returns the channels in which this bot is lobotomized. Returns the channels in which this bot is lobotomized.
.. _command-channel-lobotomy-remove:
.. _command-lobotomy-remove:
lobotomy remove [<channel>] lobotomy remove [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -42,8 +24,7 @@ bot, making it respond to requests made in the channel again.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-channel-lobotomy-add:
.. _command-lobotomy-add:
lobotomy add [<channel>] lobotomy add [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
@ -53,8 +34,28 @@ bot, making it silent and unanswering to all requests made in the
channel. *<channel>* is only necessary if the message isn't sent in channel. *<channel>* is only necessary if the message isn't sent in
the channel itself. the channel itself.
(Un)setting modes
-----------------
.. _command-deop: .. _command-channel-unmoderate:
unmoderate [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Sets -m on *<channel>*, making it so everyone can
send messages to the channel. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-channel-devoice:
devoice [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove voice from all
the nicks given. If no nicks are given, removes voice from the person
sending the message.
.. _command-channel-deop:
deop [<channel>] [<nick> ...] deop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -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 privileges from all the nicks given. If no nicks are given, removes
operator privileges from the person sending the message. operator privileges from the person sending the message.
.. _command-channel-limit:
.. _command-nicks:
nicks [<channel>] [--count]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the nicks in *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself. Returns only the number of
nicks if *--count* option is provided.
.. _command-limit:
limit [<channel>] [<limit>] limit [<channel>] [<limit>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -83,8 +73,7 @@ Sets the channel limit to *<limit>*. If *<limit>* is 0, or isn't given,
removes the channel limit. *<channel>* is only necessary if the message removes the channel limit. *<channel>* is only necessary if the message
isn't sent in the channel itself. isn't sent in the channel itself.
.. _command-channel-moderate:
.. _command-moderate:
moderate [<channel>] moderate [<channel>]
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
@ -93,8 +82,7 @@ Sets +m on *<channel>*, making it so only ops and voiced users can
send messages to the channel. *<channel>* is only necessary if the send messages to the channel. *<channel>* is only necessary if the
message isn't sent in the channel itself. message isn't sent in the channel itself.
.. _command-channel-unban:
.. _command-unban:
unban [<channel>] [<hostmask>] unban [<channel>] [<hostmask>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -105,41 +93,7 @@ hostmask. Especially useful for unbanning yourself when you get
unexpectedly (or accidentally) banned from the channel. *<channel>* is unexpectedly (or accidentally) banned from the channel. *<channel>* is
only necessary if the message isn't sent in the channel itself. only necessary if the message isn't sent in the channel itself.
.. _command-channel-dehalfop:
.. _command-kick:
kick [<channel>] <nick>[, <nick>, ...] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Kicks *<nick>*(s) from *<channel>* for *<reason>*. If *<reason>* isn't given,
uses the nick of the person making the command as the reason.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-enable:
enable [<channel>] [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will enable the *<command>*
in *<channel>* if it has been disabled. If *<plugin>* is provided,
*<command>* will be enabled only for that plugin. If only *<plugin>* is
provided, all commands in the given plugin will be enabled. *<channel>*
is only necessary if the message isn't sent in the channel itself.
.. _command-invite:
invite [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will invite *<nick>*
to join *<channel>*. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-dehalfop:
dehalfop [<channel>] [<nick> ...] dehalfop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -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 privileges from all the nicks given. If no nicks are given, removes
half-operator privileges from the person sending the message. half-operator privileges from the person sending the message.
.. _command-channel-key:
.. _command-alert:
alert [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Sends *<text>* to all the users in *<channel>* who have the *<channel>*,op
capability.
.. _command-disable:
disable [<channel>] [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will disable the *<command>*
in *<channel>*. If *<plugin>* is provided, *<command>* will be disabled only
for that plugin. If only *<plugin>* is provided, all commands in the
given plugin will be disabled. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-key:
key [<channel>] [<key>] key [<channel>] [<key>]
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
@ -179,131 +111,7 @@ Sets the keyword in *<channel>* to *<key>*. If *<key>* is not given, removes
the keyword requirement to join *<channel>*. *<channel>* is only necessary the keyword requirement to join *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself. if the message isn't sent in the channel itself.
.. _command-channel-halfop:
.. _command-ignore-list:
ignore list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Lists the hostmasks that the bot is ignoring on the given channel.
*<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-ignore-remove:
ignore remove [<channel>] <hostmask>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove the
persistent ignore on *<hostmask>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-ignore-add:
ignore add [<channel>] <nick|hostmask> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will set a persistent
ignore on *<hostmask>* or the hostmask currently
associated with *<nick>*. *<expires>* is an optional argument
specifying when (in "seconds from now") the ignore will expire; if
it isn't given, the ignore will never automatically expire.
*<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-cycle:
cycle [<channel>]
^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will cause the bot to
"cycle", or PART and then JOIN the channel. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-capability-set:
capability set [<channel>] <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will add the channel
capability *<capability>* for all users in the channel. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-capability-setdefault:
capability setdefault [<channel>] {True|False}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will set the default
response to non-power-related (that is, not {op, halfop, voice}
capabilities to be the value you give. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-capability-list:
capability list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the capabilities present on the *<channel>*. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-capability-remove:
capability remove [<channel>] <name|hostmask> <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will take from the
user currently identified as *<name>* (or the user to whom *<hostmask>*
maps) the capability *<capability>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-capability-add:
capability add [<channel>] <nick|username> <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will give the user
*<name>* (or the user to whom *<nick>* maps)
the capability *<capability>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-capability-unset:
capability unset [<channel>] <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will unset the channel
capability *<capability>* so each user's specific capability or the
channel default capability will take precedence. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-kban:
kban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will kickban *<nick>* for
as many seconds as you specify, or else (if you specify 0 seconds or
don't specify a number of seconds) it will ban the person indefinitely.
*--exact* bans only the exact hostmask; *--nick* bans just the nick;
*--user* bans just the user, and *--host* bans just the host. You can
combine these options as you choose. *<reason>* is a reason to give for
the kick.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-halfop:
halfop [<channel>] [<nick> ...] halfop [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -313,8 +121,7 @@ If you have the #channel,halfop capability, this will give all the
will give you halfops. *<channel>* is only necessary if the message isn't will give you halfops. *<channel>* is only necessary if the message isn't
sent in the channel itself. sent in the channel itself.
.. _command-channel-mode:
.. _command-mode:
mode [<channel>] <mode> [<arg> ...] mode [<channel>] <mode> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -323,8 +130,7 @@ Sets the mode in *<channel>* to *<mode>*, sending the arguments given.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-channel-ban-list:
.. _command-ban-list:
ban list [<channel>] ban list [<channel>]
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
@ -332,8 +138,7 @@ ban list [<channel>]
If you have the #channel,op capability, this will show you the If you have the #channel,op capability, this will show you the
current persistent bans on #channel. current persistent bans on #channel.
.. _command-channel-ban-remove:
.. _command-ban-remove:
ban remove [<channel>] <hostmask> ban remove [<channel>] <hostmask>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -342,8 +147,7 @@ If you have the #channel,op capability, this will remove the
persistent ban on *<hostmask>*. *<channel>* is only necessary if the persistent ban on *<hostmask>*. *<channel>* is only necessary if the
message isn't sent in the channel itself. message isn't sent in the channel itself.
.. _command-channel-ban-add:
.. _command-ban-add:
ban add [<channel>] <nick|hostmask> [<expires>] ban add [<channel>] <nick|hostmask> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -358,8 +162,7 @@ expire; if none is given, the ban will never automatically expire.
*<channel>* is only necessary if the message isn't sent in the *<channel>* is only necessary if the message isn't sent in the
channel itself. channel itself.
.. _command-channel-voice:
.. _command-voice:
voice [<channel>] [<nick> ...] voice [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -369,8 +172,7 @@ If you have the #channel,voice capability, this will voice all the
voice you. *<channel>* is only necessary if the message isn't sent in the voice you. *<channel>* is only necessary if the message isn't sent in the
channel itself. channel itself.
.. _command-channel-op:
.. _command-op:
op [<channel>] [<nick> ...] op [<channel>] [<nick> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -380,4 +182,188 @@ you provide ops. If you don't provide any *<nick>*s, this will op you.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
Inviting and kicking users
--------------------------
.. _command-channel-kick:
kick [<channel>] <nick>[, <nick>, ...] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Kicks *<nick>*(s) from *<channel>* for *<reason>*. If *<reason>* isn't given,
uses the nick of the person making the command as the reason.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-channel-invite:
invite [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will invite *<nick>*
to join *<channel>*. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-channel-kban:
kban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>] [<reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will kickban *<nick>* for
as many seconds as you specify, or else (if you specify 0 seconds or
don't specify a number of seconds) it will ban the person indefinitely.
*--exact* bans only the exact hostmask; *--nick* bans just the nick;
*--user* bans just the user, and *--host* bans just the host. You can
combine these options as you choose. *<reason>* is a reason to give for
the kick.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-channel-cycle:
cycle [<channel>]
^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will cause the bot to
"cycle", or PART and then JOIN the channel. *<channel>* is only necessary
if the message isn't sent in the channel itself.
Utitilies
---------
.. _command-channel-nicks:
nicks [<channel>] [--count]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the nicks in *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself. Returns only the number of
nicks if *--count* option is provided.
.. _command-channel-alert:
alert [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Sends *<text>* to all the users in *<channel>* who have the *<channel>*,op
capability.
.. _command-channel-disable:
disable [<channel>] [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will disable the *<command>*
in *<channel>*. If *<plugin>* is provided, *<command>* will be disabled only
for that plugin. If only *<plugin>* is provided, all commands in the
given plugin will be disabled. *<channel>* is only necessary if the
message isn't sent in the channel itself.
Ignores
.. _command-channel-cycle:
cycle [<channel>]
-------
.. _command-channel-ignore-list:
ignore list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Lists the hostmasks that the bot is ignoring on the given channel.
*<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-channel-ignore-remove:
ignore remove [<channel>] <hostmask>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will remove the
persistent ignore on *<hostmask>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-channel-ignore-add:
ignore add [<channel>] <nick|hostmask> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will set a persistent
ignore on *<hostmask>* or the hostmask currently
associated with *<nick>*. *<expires>* is an optional argument
specifying when (in "seconds from now") the ignore will expire; if
it isn't given, the ignore will never automatically expire.
*<channel>* is only necessary if the message isn't sent in the
channel itself.
Capabilities
------------
.. _command-channel-capability-set:
capability set [<channel>] <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will add the channel
capability *<capability>* for all users in the channel. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-channel-capability-setdefault:
capability setdefault [<channel>] {True|False}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will set the default
response to non-power-related (that is, not {op, halfop, voice}
capabilities to be the value you give. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-channel-capability-list:
capability list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the capabilities present on the *<channel>*. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-channel-capability-remove:
capability remove [<channel>] <name|hostmask> <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will take from the
user currently identified as *<name>* (or the user to whom *<hostmask>*
maps) the capability *<capability>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-channel-capability-add:
capability add [<channel>] <nick|username> <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will give the user
*<name>* (or the user to whom *<nick>* maps)
the capability *<capability>* in the channel. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-channel-capability-unset:
capability unset [<channel>] <capability> [<capability> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will unset the channel
capability *<capability>* so each user's specific capability or the
channel default capability will take precedence. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-channel-enable:
enable [<channel>] [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have the #channel,op capability, this will enable the *<command>*
in *<channel>* if it has been disabled. If *<plugin>* is provided,
*<command>* will be enabled only for that plugin. If only *<plugin>* is
provided, all commands in the given plugin will be enabled. *<channel>*
is only necessary if the message isn't sent in the channel itself.

28
use/plugins/channellogger.rst
View File

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

28
use/plugins/channelstats.rst
View File

@ -4,27 +4,19 @@
The ChannelStats plugin The ChannelStats plugin
======================= =======================
.. _command-stats: .. _command-channelstats-stats:
stats [<channel>] [<name>] channelstats stats [<channel>] [<name>]
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the statistics for *<name>* on *<channel>*. *<channel>* is only Returns the statistics for *<name>* on *<channel>*. *<channel>* is only
necessary if the message isn't sent on the channel itself. If *<name>* necessary if the message isn't sent on the channel itself. If *<name>*
isn't given, it defaults to the user sending the command. isn't given, it defaults to the user sending the command.
.. _command-channelstats-rank:
.. _command-die: channelstats rank [<channel>] <stat expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
die
^^^^
.. _command-rank:
rank [<channel>] <stat expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the ranking of users according to the given stat expression. Returns the ranking of users according to the given stat expression.
Valid variables in the stat expression include 'msgs', 'chars', 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 'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical
expression involving those variables is permitted. expression involving those variables is permitted.
.. _command-channelstats-channelstats:
.. _command-channelstats: channelstats channelstats [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
channelstats [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
Returns the statistics for *<channel>*. *<channel>* is only necessary if Returns the statistics for *<channel>*. *<channel>* is only necessary if
the message isn't sent on the channel itself. the message isn't sent on the channel itself.

205
use/plugins/conditional.rst
View File

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

85
use/plugins/config.rst
View File

@ -4,26 +4,27 @@
The Config plugin The Config plugin
================= =================
.. _command-help: Accessing config
----------------
help <name> .. _command-config-help:
^^^^^^^^^^^
config help <name>
^^^^^^^^^^^^^^^^^^
Returns the description of the configuration variable *<name>*. Returns the description of the configuration variable *<name>*.
.. _command-config-default:
.. _command-default: config default <name>
^^^^^^^^^^^^^^^^^^^^^
default <name>
^^^^^^^^^^^^^^
Returns the default value of the configuration variable *<name>*. Returns the default value of the configuration variable *<name>*.
.. _command-config-list:
.. _command-list: config list <group>
^^^^^^^^^^^^^^^^^^^
list <group>
^^^^^^^^^^^^
Returns the configuration variables available under the given Returns the configuration variables available under the given
configuration *<group>*. If a variable has values under it, it is configuration *<group>*. 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' it can be separately configured for each channel using the 'channel'
command in this plugin, it is preceded by an '#' sign. command in this plugin, it is preceded by an '#' sign.
.. _command-config-search:
.. _command-search: config search <word>
^^^^^^^^^^^^^^^^^^^^
search <word>
^^^^^^^^^^^^^
Searches for *<word>* in the current configuration variables. Searches for *<word>* in the current configuration variables.
.. _command-config-channel:
.. _command-reload: config channel [<channel>] <name> [<value>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
reload
^^^^^^
Reloads the various configuration files (user database, channel
database, registry, etc.).
.. _command-export:
export <filename>
^^^^^^^^^^^^^^^^^
Exports the public variables of your configuration to *<filename>*.
If you want to show someone your configuration file, but you don't
want that person to be able to see things like passwords, etc., this
command will export a "sanitized" configuration file suitable for
showing publicly.
.. _command-channel:
channel [<channel>] <name> [<value>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If *<value>* is given, sets the channel configuration variable for *<name>* If *<value>* is given, sets the channel configuration variable for *<name>*
to *<value>* for *<channel>*. Otherwise, returns the current channel to *<value>* for *<channel>*. Otherwise, returns the current channel
configuration value of *<name>*. *<channel>* is only necessary if the configuration value of *<name>*. *<channel>* is only necessary if the
message isn't sent in the channel itself. message isn't sent in the channel itself.
.. _command-config: .. _command-config-config:
config <name> [<value>] config config <name> [<value>]
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If *<value>* is given, sets the value of *<name>* to *<value>*. Otherwise, If *<value>* is given, sets the value of *<name>* to *<value>*. Otherwise,
returns the current value of *<name>*. You may omit the leading returns the current value of *<name>*. You may omit the leading
"supybot." in the name if you so choose. "supybot." in the name if you so choose.
Maintenance
-----------
.. _command-config-reload:
config reload
^^^^^^^^^^^^^
Reloads the various configuration files (user database, channel
database, registry, etc.).
.. _command-config-export:
config export <filename>
^^^^^^^^^^^^^^^^^^^^^^^^
Exports the public variables of your configuration to *<filename>*.
If you want to show someone your configuration file, but you don't
want that person to be able to see things like passwords, etc., this
command will export a "sanitized" configuration file suitable for
showing publicly.

7
use/plugins/ctcp.rst
View File

@ -4,10 +4,10 @@
The Ctcp plugin The Ctcp plugin
=============== ===============
.. _command-version: .. _command-ctcp-version:
version [<channel>] [--nicks] ctcp version [<channel>] [--nicks]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sends a CTCP VERSION to *<channel>*, returning the various Sends a CTCP VERSION to *<channel>*, returning the various
version strings returned. It waits for 10 seconds before returning 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 associated with the version strings; otherwise, only the version
strings are given. strings are given.

38
use/plugins/dict.rst
View File

@ -4,40 +4,36 @@
The Dict plugin The Dict plugin
=============== ===============
.. _command-synonym: .. _command-dict-synonym:
synonym <word> [<word> ...] dict synonym <word> [<word> ...]
Gets a random synonym from the Moby Thesaurus (moby-thes) database. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If given many words, gets a random synonym for each of them.
Quote phrases to have them treated as one lookup word.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 [<dictionary>] <word> .. _command-dict-dict:
^^^^^^^^^^^^^^^^^^^^^^^^^^
dict dict [<dictionary>] <word>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the definition of *<word>* on the dictd server specified by Looks up the definition of *<word>* 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: dict random
^^^^^^^^^^^
random
^^^^^^
Returns a random valid dictionary. Returns a random valid dictionary.
.. _command-dict-dictionaries:
.. _command-dictionaries: dict dictionaries
^^^^^^^^^^^^^^^^^
dictionaries
^^^^^^^^^^^^
Returns the dictionaries valid for the dict command. Returns the dictionaries valid for the dict command.

145
use/plugins/factoids.rst
View File

@ -4,53 +4,50 @@
The Factoids plugin The Factoids plugin
=================== ===================
.. _command-info: Reading factoids
----------------
info [<channel>] <key> .. _command-factoids-info:
^^^^^^^^^^^^^^^^^^^^^^
factoids info [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives information about the factoid(s) associated with *<key>*. Gives information about the factoid(s) associated with *<key>*.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-factoids-random:
.. _command-learn: factoids random [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
learn
^^^^^^
.. _command-forget:
forget [<channel>] <key> [<number>|*]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes a key-fact relationship for key *<key>* from the factoids
database. If there is more than one such relationship for this key,
a number is necessary to determine which one should be removed.
A * can be used to remove all relationships for *<key>*.
If as a result, the key (factoid) remains without any relationships to
a factoid (key), it shall be removed from the database.
*<channel>* is only necessary if
the message isn't sent in the channel itself.
.. _command-random:
random [<channel>]
^^^^^^^^^^^^^^^^^^
Returns a random factoid from the database for *<channel>*. *<channel>* Returns a random factoid from the database for *<channel>*. *<channel>*
is only necessary if the message isn't sent in the channel itself. is only necessary if the message isn't sent in the channel itself.
.. _command-factoids-search:
.. _command-rank: factoids search [<channel>] [--values] [--{regexp} <value>] [<glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
rank [<channel>] [--plain] [--alpha] [<number>] Searches the keyspace for keys matching *<glob>*. If *--regexp* is given,
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ it associated value is taken as a regexp and matched against the keys.
If *--values* is given, search the value space instead of the keyspace.
.. _command-factoids-whatis:
factoids whatis [<channel>] [--raw] <key> [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the value of *<key>* in the factoid database. If given a
number, will return only that exact factoid. If '*--raw'* option is
given, no variable substitution will take place on the factoid.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-factoids-rank:
factoids rank [<channel>] [--plain] [--alpha] [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a list of top-ranked factoid keys, sorted by usage count Returns a list of top-ranked factoid keys, sorted by usage count
(rank). If *<number>* is not provided, the default number of factoid keys (rank). If *<number>* is not provided, the default number of factoid keys
@ -65,43 +62,50 @@ alphabetically, instead of by rank.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
Administration
--------------
.. _command-unlock: .. _command-factoids-learn:
unlock [<channel>] <key> factoids learn [<channel>] <key> WORD <value>
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Associates *<key>* with *<value>*. *<channel>* is only
necessary if the message isn't sent on the channel
itself. The WORD (defined in :ref:`supybot.plugins.Factoids.learnSeparator`)
is necessary to separate the
key from the value. It can be changed to another word
via the :ref:`supybot.plugins.Factoids.learnSeparator` registry value.
.. _command-factoids-forget:
factoids forget [<channel>] <key> [<number>|*]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes a key-fact relationship for key *<key>* from the factoids
database. If there is more than one such relationship for this key,
a number is necessary to determine which one should be removed.
A * can be used to remove all relationships for *<key>*.
If as a result, the key (factoid) remains without any relationships to
a factoid (key), it shall be removed from the database.
*<channel>* is only necessary if
the message isn't sent in the channel itself.
.. _command-factoids-unlock:
factoids unlock [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the factoid(s) associated with *<key>* so that they can be Unlocks the factoid(s) associated with *<key>* so that they can be
removed or added to. *<channel>* is only necessary if the message isn't removed or added to. *<channel>* is only necessary if the message isn't
sent in the channel itself. sent in the channel itself.
.. _command-factoids-alias:
.. _command-search: factoids alias [<channel>] <oldkey> <newkey> [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
search [<channel>] [--values] [--{regexp} <value>] [<glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches the keyspace for keys matching *<glob>*. If *--regexp* is given,
it associated value is taken as a regexp and matched against the keys.
If *--values* is given, search the value space instead of the keyspace.
.. _command-whatis:
whatis [<channel>] [--raw] <key> [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the value of *<key>* in the factoid database. If given a
number, will return only that exact factoid. If '*--raw'* option is
given, no variable substitution will take place on the factoid.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-alias:
alias [<channel>] <oldkey> <newkey> [<number>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds a new key *<newkey>* for factoid associated with *<oldkey>*. Adds a new key *<newkey>* for factoid associated with *<oldkey>*.
*<number>* is only necessary if there's more than one factoid associated *<number>* is only necessary if there's more than one factoid associated
@ -110,23 +114,20 @@ with *<oldkey>*.
The same action can be accomplished by using the 'learn' function with The same action can be accomplished by using the 'learn' function with
a new key but an existing (verbatim) factoid content. a new key but an existing (verbatim) factoid content.
.. _command-factoids-change:
.. _command-change: factoids change [<channel>] <key> <number> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
change [<channel>] <key> <number> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes the factoid #*<number>* associated with *<key>* according to Changes the factoid #*<number>* associated with *<key>* according to
*<regexp>*. *<regexp>*.
.. _command-factoids-lock:
.. _command-lock: factoids lock [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lock [<channel>] <key>
^^^^^^^^^^^^^^^^^^^^^^
Locks the factoid(s) associated with *<key>* so that they cannot be Locks the factoid(s) associated with *<key>* so that they cannot be
removed or added to. *<channel>* is only necessary if the message isn't removed or added to. *<channel>* is only necessary if the message isn't
sent in the channel itself. sent in the channel itself.

306
use/plugins/filter.rst
View File

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

179
use/plugins/format.rst
View File

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

48
use/plugins/games.rst
View File

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

66
use/plugins/google.rst
View File

@ -4,78 +4,64 @@
The Google plugin The Google plugin
================= =================
.. _command-google: Web search
----------
google <search> [--{filter,language} <value>] .. _command-google-google:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
google google <search> [--{filter,language} <value>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches google.com for the given string. As many results as can fit Searches google.com for the given string. As many results as can fit
are included. *--language* accepts a language abbreviation; *--filter are included. *--language* accepts a language abbreviation; *--filter
accepts* a filtering level ('active', 'moderate', 'off'). accepts* a filtering level ('active', 'moderate', 'off').
.. _command-google-cache:
.. _command-search: google cache <url>
^^^^^^^^^^^^^^^^^^
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 <url>
^^^^^^^^^^^
Returns a link to the cached version of *<url>* if it is available. Returns a link to the cached version of *<url>* if it is available.
.. _command-google-lucky:
.. _command-lucky: google lucky [--snippet] <search>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lucky [--snippet] <search>
^^^^^^^^^^^^^^^^^^^^^^^^^^
Does a google search, but only returns the first result. Does a google search, but only returns the first result.
If option *--snippet* is given, returns also the page text snippet. If option *--snippet* is given, returns also the page text snippet.
.. _command-google-fight:
.. _command-fight: google fight <search string> <search string> [<search string> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
fight <search string> <search string> [<search string> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the results of each search, in order, from greatest number Returns the results of each search, in order, from greatest number
of results to least. of results to least.
Others
------
.. _command-phonebook: .. _command-google-phonebook:
phonebook <phone number> google phonebook <phone number>
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks *<phone number>* up on Google. Looks *<phone number>* up on Google.
.. _command-google-calc:
.. _command-calc: google calc <expression>
^^^^^^^^^^^^^^^^^^^^^^^^
calc <expression>
^^^^^^^^^^^^^^^^^
Uses Google's calculator to calculate the value of *<expression>*. Uses Google's calculator to calculate the value of *<expression>*.
.. _command-google-translate:
.. _command-translate: google translate <from-language> [to] <to-language> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
translate <from-language> [to] <to-language> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* translated from *<from-language>* into *<to-language>*. Returns *<text>* translated from *<from-language>* into *<to-language>*.
Beware that translating to or from languages that use multi-byte Beware that translating to or from languages that use multi-byte
characters may result in some very odd results. characters may result in some very odd results.

72
use/plugins/herald.rst
View File

@ -4,28 +4,23 @@
The Herald plugin The Herald plugin
================= =================
.. _command-get: User commands
-------------
get [<channel>] [<user|nick>] .. _command-herald-get:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
herald get [<channel>] [<user|nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current herald message for *<user>* (or the user Returns the current herald message for *<user>* (or the user
*<nick|hostmask>* is currently identified or recognized as). If *<user>* *<nick|hostmask>* is currently identified or recognized as). If *<user>*
is not given, defaults to the user giving the command. *<channel>* is not given, defaults to the user giving the command. *<channel>*
is only necessary if the message isn't sent in the channel itself. is only necessary if the message isn't sent in the channel itself.
.. _command-herald-remove:
.. _command-die: herald remove [<channel>] [<user|nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
die
^^^^
.. _command-remove:
remove [<channel>] [<user|nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the herald message set for *<user>*, or the user Removes the herald message set for *<user>*, or the user
*<nick|hostmask>* is currently identified or recognized as. If *<user>* *<nick|hostmask>* is currently identified or recognized as. If *<user>*
@ -33,36 +28,35 @@ is not given, defaults to the user giving the command.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-herald-change:
.. _command-default: herald change [<channel>] [<user|nick>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
default [<channel>] [--remove|<msg>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If *<msg>* is given, sets the default herald to *<msg>*. A *<msg>* of ""
will remove the default herald. If *<msg>* is not given, returns the
current default herald. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-add:
add [<channel>] <user|nick> <msg>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the herald message for *<user>* (or the user *<nick|hostmask>* is
currently identified or recognized as) to *<msg>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-change:
change [<channel>] [<user|nick>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes the herald message for *<user>*, or the user *<nick|hostmask>* is Changes the herald message for *<user>*, or the user *<nick|hostmask>* is
currently identified or recognized as, according to *<regexp>*. If currently identified or recognized as, according to *<regexp>*. If
*<user>* is not given, defaults to the calling user. *<channel>* is only *<user>* is not given, defaults to the calling user. *<channel>* is only
necessary if the message isn't sent in the channel itself. necessary if the message isn't sent in the channel itself.
Op commands
-----------
.. _command-herald-default:
herald default [<channel>] [--remove|<msg>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If *<msg>* is given, sets the default herald to *<msg>*. A *<msg>* of ""
will remove the default herald. If *<msg>* is not given, returns the
current default herald. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-herald-add:
herald add [<channel>] <user|nick> <msg>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the herald message for *<user>* (or the user *<nick|hostmask>* is
currently identified or recognized as) to *<msg>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.

93
use/plugins/index.rst
View File

@ -10,5 +10,96 @@ Main plugins
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
owner.rst
admin.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

21
use/plugins/internet.rst
View File

@ -4,27 +4,24 @@
The Internet plugin The Internet plugin
=================== ===================
.. _command-whois: .. _command-internet-whois:
whois <domain> internet whois <domain>
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
Returns WHOIS information on the registration of *<domain>*. Returns WHOIS information on the registration of *<domain>*.
.. _command-internet-dns:
.. _command-dns: internet dns <host|ip>
^^^^^^^^^^^^^^^^^^^^^^
dns <host|ip>
^^^^^^^^^^^^^
Returns the ip of *<host>* or the reverse DNS hostname of *<ip>*. Returns the ip of *<host>* or the reverse DNS hostname of *<ip>*.
.. _command-internet-hexip:
.. _command-hexip: internet hexip <ip>
^^^^^^^^^^^^^^^^^^^
hexip <ip>
^^^^^^^^^^
Returns the hexadecimal IP for that IP. Returns the hexadecimal IP for that IP.

70
use/plugins/karma.rst
View File

@ -4,61 +4,55 @@
The Karma plugin The Karma plugin
================ ================
.. _command-load: Main commands
-------------
load [<channel>] <filename> .. _command-karma-clear:
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Loads the Karma database for *<channel>* from *<filename>* in the bot's karma clear [<channel>] <name>
data directory. *<channel>* is only necessary if the message isn't sent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
in the channel itself.
.. _command-dump:
dump [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Dumps the Karma database for *<channel>* to *<filename>* in the bot's
data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.
.. _command-die:
die
^^^^
.. _command-clear:
clear [<channel>] <name>
^^^^^^^^^^^^^^^^^^^^^^^^
Resets the karma of *<name>* to 0. Resets the karma of *<name>* to 0.
.. _command-karma-most:
.. _command-most: karma most [<channel>] {increased,decreased,active}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
most [<channel>] {increased,decreased,active}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the most increased, the most decreased, or the most active Returns the most increased, the most decreased, or the most active
(the sum of increased and decreased) karma things. *<channel>* is only (the sum of increased and decreased) karma things. *<channel>* is only
necessary if the message isn't sent in the channel itself. necessary if the message isn't sent in the channel itself.
.. _command-karma-karma:
.. _command-karma: karma karma [<channel>] [<thing> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
karma [<channel>] [<thing> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the karma of *<thing>*. If *<thing>* is not given, returns the top Returns the karma of *<thing>*. If *<thing>* is not given, returns the top
N karmas, where N is determined by the config variable N karmas, where N is determined by the config variable
supybot.plugins.Karma.rankingDisplay. If one *<thing>* is given, returns :ref:`supybot.plugins.Karma.rankingDisplay.` If one *<thing>* is given, returns
the details of its karma; if more than one *<thing>* is given, returns the details of its karma; if more than one *<thing>* is given, returns
the total karma of each of the the things. *<channel>* is only necessary the total karma of each of the the things. *<channel>* is only necessary
if the message isn't sent on the channel itself. if the message isn't sent on the channel itself.
Maintenance
-----------
.. _command-karma-load:
karma load [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Loads the Karma database for *<channel>* from *<filename>* in the bot's
data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.
.. _command-karma-dump:
karma dump [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Dumps the Karma database for *<channel>* to *<filename>* in the bot's
data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.

7
use/plugins/lart.rst
View File

@ -4,13 +4,12 @@
The Lart plugin The Lart plugin
=============== ===============
.. _command-lart: .. _command-lart-lart:
lart [<channel>] [<id>] <who|what> [for <reason>] lart lart [<channel>] [<id>] <who|what> [for <reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Uses the Luser Attitude Readjustment Tool on *<who|what>* (for *<reason>*, Uses the Luser Attitude Readjustment Tool on *<who|what>* (for *<reason>*,
if given). If *<id>* is given, uses that specific lart. *<channel>* is if given). If *<id>* is given, uses that specific lart. *<channel>* is
only necessary if the message isn't sent in the channel itself. only necessary if the message isn't sent in the channel itself.

28
use/plugins/later.rst
View File

@ -4,37 +4,27 @@
The Later plugin The Later plugin
================ ================
.. _command-die: .. _command-later-notes:
die later notes [<nick>]
^^^^ ^^^^^^^^^^^^^^^^^^^^
.. _command-notes:
notes [<nick>]
^^^^^^^^^^^^^^
If *<nick>* is given, replies with what notes are waiting on *<nick>*, If *<nick>* is given, replies with what notes are waiting on *<nick>*,
otherwise, replies with the nicks that have notes waiting for them. otherwise, replies with the nicks that have notes waiting for them.
.. _command-later-remove:
.. _command-remove: later remove <nick>
^^^^^^^^^^^^^^^^^^^
remove <nick>
^^^^^^^^^^^^^
Removes the notes waiting on *<nick>*. Removes the notes waiting on *<nick>*.
.. _command-later-tell:
.. _command-tell: later tell <nick> <text>
^^^^^^^^^^^^^^^^^^^^^^^^
tell <nick> <text>
^^^^^^^^^^^^^^^^^^
Tells *<nick>* *<text>* the next time *<nick>* is in seen. *<nick>* can Tells *<nick>* *<text>* the next time *<nick>* is in seen. *<nick>* can
contain wildcard characters, and the first matching nick will be contain wildcard characters, and the first matching nick will be
given the note. given the note.

54
use/plugins/math.rst
View File

@ -4,56 +4,57 @@
The Math plugin The Math plugin
=============== ===============
.. _command-base: Conversion
----------
base <fromBase> [<toBase>] <number> .. _command-math-base:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
math base <fromBase> [<toBase>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Converts *<number>* from base *<fromBase>* to base *<toBase>*. Converts *<number>* from base *<fromBase>* to base *<toBase>*.
If *<toBase>* is left out, it converts to decimal. If *<toBase>* is left out, it converts to decimal.
.. _command-math-convert:
.. _command-rpn: math convert [<number>] <unit> to <other unit>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
rpn <rpn math expression>
^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the value of an RPN expression.
.. _command-convert:
convert [<number>] <unit> to <other unit>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Converts from *<unit>* to *<other unit>*. If number isn't given, it Converts from *<unit>* to *<other unit>*. If number isn't given, it
defaults to 1. For unit information, see 'units' command. defaults to 1. For unit information, see 'units' command.
Calculation
-----------
.. _command-icalc: .. _command-math-rpn:
icalc <math expression> math rpn <rpn math expression>
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the value of an RPN expression.
.. _command-math-icalc:
math icalc <math expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This is the same as the calc command except that it allows integer 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 math, and can thus cause the bot to suck up CPU. Hence it requires
the 'trusted' capability to use. the 'trusted' capability to use.
.. _command-math-units:
.. _command-units: math units [<type>]
^^^^^^^^^^^^^^^^^^^
units [<type>]
^^^^^^^^^^^^^^
With no arguments, returns a list of measurement types, which can be With no arguments, returns a list of measurement types, which can be
passed as arguments. When called with a type as an argument, returns passed as arguments. When called with a type as an argument, returns
the units of that type. the units of that type.
.. _command-math-calc:
.. _command-calc: math calc <math expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
calc <math expression>
^^^^^^^^^^^^^^^^^^^^^^
Returns the value of the evaluated *<math expression>*. The syntax is Returns the value of the evaluated *<math expression>*. The syntax is
Python syntax; the type of arithmetic is floating point. Floating 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 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. is that large values such as '10**24' might not be exact.

114
use/plugins/messageparser.rst
View File

@ -4,52 +4,52 @@
The MessageParser plugin The MessageParser plugin
======================== ========================
.. _command-show: Administration
--------------
show [<channel>] [--id] <regexp> .. _command-messageparser-remove:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the value of *<regexp>* in the triggers database. messageparser remove [<channel>] [--id] <regexp>]
*<channel>* is only necessary if the message isn't sent in the channel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
itself.
Removes the trigger for *<regexp>* from the triggers database.
*<channel>* is only necessary if
the message isn't sent in the channel itself.
If option *--id* specified, will retrieve by regexp id, not content. If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-add:
.. _command-lock: messageparser add [<channel>] <regexp> <action>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lock [<channel>] <regexp> Associates *<regexp>* with *<action>*. *<channel>* is only
^^^^^^^^^^^^^^^^^^^^^^^^^ necessary if the message isn't sent on the channel
itself. Action is echoed upon regexp match, with variables $1, $2,
etc. being interpolated from the regexp match groups.
.. _command-messageparser-lock:
messageparser lock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Locks the *<regexp>* so that it cannot be Locks the *<regexp>* so that it cannot be
removed or overwritten to. *<channel>* is only necessary if the message isn't removed or overwritten to. *<channel>* is only necessary if the message isn't
sent in the channel itself. sent in the channel itself.
.. _command-messageparser-unlock:
.. _command-rank: messageparser unlock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
rank [<channel>]
^^^^^^^^^^^^^^^^
Returns a list of top-ranked regexps, sorted by usage count
(rank). The number of regexps returned is set by the
rankListLength registry value. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-unlock:
unlock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the entry associated with *<regexp>* so that it can be Unlocks the entry associated with *<regexp>* so that it can be
removed or overwritten. *<channel>* is only necessary if the message isn't removed or overwritten. *<channel>* is only necessary if the message isn't
sent in the channel itself. sent in the channel itself.
.. _command-messageparser-vacuum:
.. _command-vacuum: messageparser vacuum [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
vacuum [<channel>]
^^^^^^^^^^^^^^^^^^
Vacuums the database for *<channel>*. Vacuums the database for *<channel>*.
See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html 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 First check if user has the required capability specified in plugin
config requireVacuumCapability. config requireVacuumCapability.
User commands
-------------
.. _command-info: .. _command-messageparser-show:
info [<channel>] [--id] <regexp> messageparser show [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the value of *<regexp>* in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-rank:
messageparser rank [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a list of top-ranked regexps, sorted by usage count
(rank). The number of regexps returned is set by the
rankListLength registry value. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-messageparser-info:
messageparser info [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Display information about *<regexp>* in the triggers database. Display information about *<regexp>* in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
If option *--id* specified, will retrieve by regexp id, not content. If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-list:
.. _command-list: messageparser list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
list [<channel>]
^^^^^^^^^^^^^^^^
Lists regexps present in the triggers database. Lists regexps present in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. Regexp ID listed in paretheses. itself. Regexp ID listed in paretheses.
.. _command-remove:
remove [<channel>] [--id] <regexp>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the trigger for *<regexp>* from the triggers database.
*<channel>* is only necessary if
the message isn't sent in the channel itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-add:
add [<channel>] <regexp> <action>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Associates *<regexp>* with *<action>*. *<channel>* is only
necessary if the message isn't sent on the channel
itself. Action is echoed upon regexp match, with variables $1, $2,
etc. being interpolated from the regexp match groups.

123
use/plugins/misc.rst
View File

@ -4,10 +4,43 @@
The Misc plugin The Misc plugin
=============== ===============
.. _command-last: Main commands
-------------
last [--{from,in,on,with,without,regexp} <value>] [--nolimit] .. _command-misc-help:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
misc help [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This command gives a useful description of what *<command>* does.
*<plugin>* is only necessary if the command is in more than one plugin.
.. _command-misc-list:
misc list [--private] [<plugin>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the commands available in the given plugin. If no plugin is
given, lists the public plugins available. If *--private* is given,
lists the private plugins.
.. _command-misc-more:
misc more [<nick>]
^^^^^^^^^^^^^^^^^^
If the last command was truncated due to IRC message length
limitations, returns the next chunk of the result of the last command.
If *<nick>* is given, it takes the continuation of the last command from
*<nick>* instead of the person sending this message.
Utilities
---------
.. _command-misc-last:
misc last [--{from,in,on,with,without,regexp} <value>] [--nolimit]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last message matching the given criteria. *--from* requires Returns the last message matching the given criteria. *--from* requires
a nick from whom the message came; *--in* requires a channel the message 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 the messages that can be found. By default, the channel this command is
given in is searched. given in is searched.
.. _command-misc-ping:
.. _command-help: misc ping
^^^^^^^^^
help [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
This command gives a useful description of what *<command>* does.
*<plugin>* is only necessary if the command is in more than one plugin.
.. _command-list:
list [--private] [<plugin>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the commands available in the given plugin. If no plugin is
given, lists the public plugins available. If *--private* is given,
lists the private plugins.
.. _command-ping:
ping
^^^^
Checks to see if the bot is alive. Checks to see if the bot is alive.
.. _command-misc-tell:
.. _command-source: misc tell <nick> <text>
^^^^^^^^^^^^^^^^^^^^^^^
source
^^^^^^
Returns a URL saying where to get Supybot.
.. _command-version:
version
^^^^^^^
Returns the version of the current bot.
.. _command-apropos:
apropos <string>
^^^^^^^^^^^^^^^^
Searches for *<string>* in the commands currently offered by the bot,
returning a list of the commands containing that string.
.. _command-tell:
tell <nick> <text>
^^^^^^^^^^^^^^^^^^
Tells the *<nick>* whatever *<text>* is. Use nested commands to your Tells the *<nick>* whatever *<text>* is. Use nested commands to your
benefit here. benefit here.
Getting informations about the bot
----------------------------------
.. _command-more: .. _command-misc-source:
more [<nick>] misc source
^^^^^^^^^^^^^ ^^^^^^^^^^^
If the last command was truncated due to IRC message length Returns a URL saying where to get Supybot.
limitations, returns the next chunk of the result of the last command.
If *<nick>* is given, it takes the continuation of the last command from
*<nick>* instead of the person sending this message.
.. _command-misc-version:
misc version
^^^^^^^^^^^^
Returns the version of the current bot.
.. _command-misc-apropos:
misc apropos <string>
^^^^^^^^^^^^^^^^^^^^^
Searches for *<string>* in the commands currently offered by the bot,
returning a list of the commands containing that string.

122
use/plugins/moobotfactoids.rst
View File

@ -4,119 +4,101 @@
The MoobotFactoids plugin The MoobotFactoids plugin
========================= =========================
.. _command-lock: Reading factoids
----------------
lock [<channel>] <factoid key> .. _command-moobotfactoids-listauth:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Locks the factoid with the given factoid key. Requires that the user moobotfactoids listauth [<channel>] <author name>
be registered and have created the factoid originally. *<channel>* is ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
only necessary if the message isn't sent in the channel itself.
.. _command-listauth:
listauth [<channel>] <author name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the keys of the factoids with the given author. Note that if an 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 author has an integer name, you'll have to use that author's id to use
this function (so don't use integer usernames!). *<channel>* is only this function (so don't use integer usernames!). *<channel>* is only
necessary if the message isn't sent in the channel itself. necessary if the message isn't sent in the channel itself.
.. _command-moobotfactoids-random:
.. _command-random: moobotfactoids random [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
random [<channel>]
^^^^^^^^^^^^^^^^^^
Displays a random factoid (along with its key) from the database. Displays a random factoid (along with its key) from the database.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-moobotfactoids-literal:
.. _command-unlock: moobotfactoids literal [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
unlock [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the factoid with the given factoid key. Requires that the
user be registered and have locked the factoid. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-literal:
literal [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the literal factoid for the given factoid key. No parsing of Returns the literal factoid for the given factoid key. No parsing of
the factoid value is done as it is with normal retrieval. *<channel>* the factoid value is done as it is with normal retrieval. *<channel>*
is only necessary if the message isn't sent in the channel itself. is only necessary if the message isn't sent in the channel itself.
.. _command-moobotfactoids-listvalues:
.. _command-listvalues: moobotfactoids listvalues [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
listvalues [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the keys of the factoids whose value contains the provided text. Lists the keys of the factoids whose value contains the provided text.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-moobotfactoids-factinfo:
.. _command-reset: moobotfactoids factinfo [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
reset
^^^^^^
.. _command-factinfo:
factinfo [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the various bits of info on the factoid for the given key. Returns the various bits of info on the factoid for the given key.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-moobotfactoids-most:
.. _command-most: moobotfactoids most [<channel>] {popular|authored|recent}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
most [<channel>] {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 most frequently requested factoids. "authored" lists the author with
the most factoids. "recent" lists the most recently created factoids. the most factoids. "recent" lists the most recently created factoids.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-moobotfactoids-listkeys:
.. _command-die: moobotfactoids listkeys [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
die
^^^^
.. _command-remove:
remove [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Deletes the factoid with the given key. *<channel>* is only necessary
if the message isn't sent in the channel itself.
.. _command-listkeys:
listkeys [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the keys of the factoids whose key contains the provided text. Lists the keys of the factoids whose key contains the provided text.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
Administration
--------------
.. _command-moobotfactoids-lock:
moobotfactoids lock [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Locks the factoid with the given factoid key. Requires that the user
be registered and have created the factoid originally. *<channel>* is
only necessary if the message isn't sent in the channel itself.
.. _command-moobotfactoids-unlock:
moobotfactoids unlock [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the factoid with the given factoid key. Requires that the
user be registered and have locked the factoid. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-moobotfactoids-remove:
moobotfactoids remove [<channel>] <factoid key>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Deletes the factoid with the given key. *<channel>* is only necessary
if the message isn't sent in the channel itself.

106
use/plugins/network.rst
View File

@ -4,20 +4,60 @@
The Network plugin The Network plugin
================== ==================
.. _command-driver: Getting status
--------------
driver [<network>] .. _command-network-driver:
^^^^^^^^^^^^^^^^^^
network driver [<network>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current network driver for *<network>*. *<network>* is only Returns the current network driver for *<network>*. *<network>* is only
necessary if the message isn't sent on the network to which this necessary if the message isn't sent on the network to which this
command is to apply. command is to apply.
.. _command-network-networks:
.. _command-connect: network networks
^^^^^^^^^^^^^^^^
connect [--ssl] <network> [<host[:port]>] [<password>] Returns the networks to which the bot is currently connected.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-network-latency:
network latency [<network>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current latency to *<network>*. *<network>* is only necessary
if the message isn't sent on the network to which this command is to
apply.
Running commands
----------------
.. _command-network-whois:
network whois [<network>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the WHOIS response *<network>* gives for *<nick>*. *<network>* is
only necessary if the network is different than the network the command
is sent on.
.. _command-network-command:
network command <network> <command> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the bot *<command>* (with its associated *<arg>*s) on *<network>*.
(Dis)connecting
---------------
.. _command-network-connect:
network connect [--ssl] <network> [<host[:port]>] [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Connects to another network (which will be represented by the name Connects to another network (which will be represented by the name
provided in *<network>*) at *<host:port>*. If port is not provided, it provided in *<network>*) at *<host:port>*. 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, it will be sent to the server in a PASS command. If *--ssl* is
provided, an SSL connection will be attempted. provided, an SSL connection will be attempted.
.. _command-network-reconnect:
.. _command-reconnect: network reconnect [<network>] [<quit message>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
reconnect [<network>] [<quit message>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Disconnects and then reconnects to *<network>*. If no network is given, Disconnects and then reconnects to *<network>*. If no network is given,
disconnects and then reconnects to the network the command was given disconnects and then reconnects to the network the command was given
on. If no quit message is given, uses the configured one 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.
.. _command-network-disconnect:
.. _command-networks: network disconnect [<network>] [<quit message>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
networks
^^^^^^^^
Returns the networks to which the bot is currently connected.
.. _command-latency:
latency [<network>]
^^^^^^^^^^^^^^^^^^^
Returns the current latency to *<network>*. *<network>* is only necessary
if the message isn't sent on the network to which this command is to
apply.
.. _command-disconnect:
disconnect [<network>] [<quit message>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Disconnects from the network represented by the network *<network>*. Disconnects from the network represented by the network *<network>*.
If *<quit message>* is given, quits the network with the given quit If *<quit message>* is given, quits the network with the given quit
message. *<network>* is only necessary if the network is different message. *<network>* is only necessary if the network is different
from the network the command is sent on. from the network the command is sent on.
.. _command-whois:
whois [<network>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns the WHOIS response *<network>* gives for *<nick>*. *<network>* is
only necessary if the network is different than the network the command
is sent on.
.. _command-command:
command <network> <command> [<arg> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the bot *<command>* (with its associated *<arg>*s) on *<network>*.

70
use/plugins/news.rst
View File

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

14
use/plugins/nickometer.rst
View File

@ -4,19 +4,11 @@
The Nickometer plugin The Nickometer plugin
===================== =====================
.. _command-punish: .. _command-nickometer-nickometer:
punish nickometer nickometer [<nick>]
^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-nickometer:
nickometer [<nick>]
^^^^^^^^^^^^^^^^^^^
Tells you how lame said nick is. If *<nick>* is not given, uses the Tells you how lame said nick is. If *<nick>* is not given, uses the
nick of the person giving the command. nick of the person giving the command.

86
use/plugins/note.rst
View File

@ -4,74 +4,66 @@
The Note plugin The Note plugin
=============== ===============
.. _command-unsend: Reading notes
-------------
unsend <id> .. _command-note-search:
^^^^^^^^^^^
Unsends the note with the id given. You must be the note search [--{regexp} <value>] [--sent] [<glob>]
author of the note, and it must be unread. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-search:
search [--{regexp} <value>] [--sent] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches your received notes for ones matching *<glob>*. If *--regexp* is Searches your received notes for ones matching *<glob>*. If *--regexp* is
given, its associated value is taken as a regexp and matched against given, its associated value is taken as a regexp and matched against
the notes. If *--sent* is specified, only search sent notes. the notes. If *--sent* is specified, only search sent notes.
.. _command-note-list:
.. _command-reply: note list [--{old,sent}] [--{from,to} <user>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
reply <id> <text>
^^^^^^^^^^^^^^^^^
Sends a note in reply to *<id>*.
.. _command-die:
die
^^^^
.. _command-list:
list [--{old,sent}] [--{from,to} <user>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Retrieves the ids of all your unread notes. If *--old* is given, list 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 read notes. If *--sent* is given, list notes that you have sent. If
*--from* is specified, only lists notes sent to you from *<user>*. If *--from* is specified, only lists notes sent to you from *<user>*. If
*--to* is specified, only lists notes sent by you to *<user>*. *--to* is specified, only lists notes sent by you to *<user>*.
.. _command-note-next:
.. _command-send: note next
^^^^^^^^^
send <recipient>,[<recipient>,[...]] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sends a new note to the user specified. Multiple recipients may be
specified by separating their names by commas.
.. _command-next:
next
^^^^
Retrieves your next unread note, if any. Retrieves your next unread note, if any.
.. _command-note-note:
.. _command-note: note note <id>
^^^^^^^^^^^^^^
note <id>
^^^^^^^^^
Retrieves a single note by its unique note id. Use the 'note list' Retrieves a single note by its unique note id. Use the 'note list'
command to see what unread notes you have. command to see what unread notes you have.
Sending notes
-------------
.. _command-note-unsend:
note unsend <id>
^^^^^^^^^^^^^^^^
Unsends the note with the id given. You must be the
author of the note, and it must be unread.
.. _command-note-reply:
note reply <id> <text>
^^^^^^^^^^^^^^^^^^^^^^
Sends a note in reply to *<id>*.
.. _command-note-send:
note send <recipient>,[<recipient>,[...]] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sends a new note to the user specified. Multiple recipients may be
specified by separating their names by commas.

199
use/plugins/owner.rst
View File

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

64
use/plugins/plugin.rst
View File

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

12
use/plugins/plugindownloader.rst
View File

@ -4,17 +4,17 @@
The PluginDownloader plugin The PluginDownloader plugin
=========================== ===========================
.. _command-install: .. _command-plugindownloader-install:
install <repository> <plugin> plugindownloader install <repository> <plugin>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Downloads and installs the *<plugin>* from the *<repository>*. Downloads and installs the *<plugin>* from the *<repository>*.
.. _command-repolist: .. _command-plugindownloader-repolist:
repolist [<repository>] plugindownloader repolist [<repository>]
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Displays the list of plugins in the *<repository>*. Displays the list of plugins in the *<repository>*.
If *<repository>* is not given, returns a list of available If *<repository>* is not given, returns a list of available

7
use/plugins/praise.rst
View File

@ -4,13 +4,12 @@
The Praise plugin The Praise plugin
================= =================
.. _command-praise: .. _command-praise-praise:
praise [<channel>] [<id>] <who|what> [for <reason>] praise praise [<channel>] [<id>] <who|what> [for <reason>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Praises *<who|what>* (for *<reason>*, if given). If *<id>* is given, uses Praises *<who|what>* (for *<reason>*, if given). If *<id>* is given, uses
that specific praise. *<channel>* is only necessary if the message isn't that specific praise. *<channel>* is only necessary if the message isn't
sent in the channel itself. sent in the channel itself.

7
use/plugins/protector.rst
View File

@ -4,10 +4,3 @@
The Protector plugin The Protector plugin
==================== ====================
.. _command-demote:
demote
^^^^^^^

7
use/plugins/quote.rst
View File

@ -4,12 +4,11 @@
The Quote plugin The Quote plugin
================ ================
.. _command-random: .. _command-quote-random:
random [<channel>] quote random [<channel>]
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
Returns a random quote from *<channel>*. *<channel>* is only necessary if Returns a random quote from *<channel>*. *<channel>* is only necessary if
the message isn't sent in the channel itself. the message isn't sent in the channel itself.

63
use/plugins/quotegrabs.rst
View File

@ -4,71 +4,70 @@
The QuoteGrabs plugin The QuoteGrabs plugin
===================== =====================
.. _command-ungrab: Getting quotes
--------------
ungrab [<channel>] <number> .. _command-quotegrabs-get:
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the grab *<number>* (the last by default) on *<channel>*. quotegrabs get [<channel>] <id>
*<channel>* is only necessary if the message isn't sent in the channel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
itself.
.. _command-get:
get [<channel>] <id>
^^^^^^^^^^^^^^^^^^^^
Return the quotegrab with the given *<id>*. *<channel>* is only necessary Return the quotegrab with the given *<id>*. *<channel>* is only necessary
if the message isn't sent in the channel itself. if the message isn't sent in the channel itself.
.. _command-quotegrabs-quote:
.. _command-quote: quotegrabs quote [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
quote [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<nick>*'s latest quote grab in *<channel>*. *<channel>* is only Returns *<nick>*'s latest quote grab in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself. necessary if the message isn't sent in the channel itself.
.. _command-quotegrabs-random:
.. _command-random: quotegrabs random [<channel>] [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
random [<channel>] [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a randomly grabbed quote, optionally choosing only from those Returns a randomly grabbed quote, optionally choosing only from those
quotes grabbed for *<nick>*. *<channel>* is only necessary if the message quotes grabbed for *<nick>*. *<channel>* is only necessary if the message
isn't sent in the channel itself. isn't sent in the channel itself.
.. _command-quotegrabs-list:
.. _command-list: quotegrabs list [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
list [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^
Returns a list of shortened quotes that have been grabbed for *<nick>* Returns a list of shortened quotes that have been grabbed for *<nick>*
as well as the id of each quote. These ids can be used to get the as well as the id of each quote. These ids can be used to get the
full quote. *<channel>* is only necessary if the message isn't sent in full quote. *<channel>* is only necessary if the message isn't sent in
the channel itself. the channel itself.
.. _command-quotegrabs-search:
.. _command-search: quotegrabs search [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
search [<channel>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^
Searches for *<text>* in a quote. *<channel>* is only necessary if the Searches for *<text>* in a quote. *<channel>* is only necessary if the
message isn't sent in the channel itself. message isn't sent in the channel itself.
(Un)quoting
-----------
.. _command-grab: .. _command-quotegrabs-ungrab:
grab [<channel>] <nick> quotegrabs ungrab [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the grab *<number>* (the last by default) on *<channel>*.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-quotegrabs-grab:
quotegrabs grab [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Grabs a quote from *<channel>* by *<nick>* for the quotegrabs table. Grabs a quote from *<channel>* by *<nick>* for the quotegrabs table.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.

21
use/plugins/relay.rst
View File

@ -4,30 +4,28 @@
The Relay plugin The Relay plugin
================ ================
.. _command-nicks: .. _command-relay-nicks:
nicks [<channel>] relay nicks [<channel>]
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
Returns the nicks of the people in the channel on the various networks Returns the nicks of the people in the channel on the various networks
the bot is connected to. *<channel>* is only necessary if the message the bot is connected to. *<channel>* is only necessary if the message
isn't sent on the channel itself. isn't sent on the channel itself.
.. _command-relay-part:
.. _command-part: relay part <channel>
^^^^^^^^^^^^^^^^^^^^
part <channel>
^^^^^^^^^^^^^^
Ceases relaying between the channel *<channel>* on all networks. The bot Ceases relaying between the channel *<channel>* on all networks. The bot
will part from the channel on all networks in which it is on the will part from the channel on all networks in which it is on the
channel. channel.
.. _command-relay-join:
.. _command-join: relay join [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
join [<channel>]
^^^^^^^^^^^^^^^^
Starts relaying between the channel *<channel>* on all networks. If on a Starts relaying between the channel *<channel>* on all networks. If on a
network the bot isn't in *<channel>*, he'll join. This commands is network the bot isn't in *<channel>*, he'll join. This commands is
@ -36,4 +34,3 @@ relay between those channels unless he's told to join both
channels. If *<channel>* is not given, starts relaying on the channel channels. If *<channel>* is not given, starts relaying on the channel
the message was sent in. the message was sent in.

37
use/plugins/reply.rst
View File

@ -4,47 +4,42 @@
The Reply plugin The Reply plugin
================ ================
.. _command-notice: .. _command-reply-notice:
notice <text> reply notice <text>
^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
Replies with *<text>* in a notice. Use nested commands to your benefit Replies with *<text>* in a notice. Use nested commands to your benefit
here. If you want a private notice, nest the private command. here. If you want a private notice, nest the private command.
.. _command-reply-private:
.. _command-private: reply private <text>
^^^^^^^^^^^^^^^^^^^^
private <text>
^^^^^^^^^^^^^^
Replies with *<text>* in private. Use nested commands to your benefit Replies with *<text>* in private. Use nested commands to your benefit
here. here.
.. _command-reply-replies:
.. _command-replies: reply replies <str> [<str> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
replies <str> [<str> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with each of its arguments *<str>* in separate replies, depending Replies with each of its arguments *<str>* in separate replies, depending
the configuration of supybot.reply.oneToOne. the configuration of :ref:`supybot.reply.oneToOne.`
.. _command-reply-action:
.. _command-action: reply action <text>
^^^^^^^^^^^^^^^^^^^
action <text>
^^^^^^^^^^^^^
Replies with *<text>* as an action. use nested commands to your benefit Replies with *<text>* as an action. use nested commands to your benefit
here. here.
.. _command-reply-reply:
.. _command-reply: reply reply <text>
^^^^^^^^^^^^^^^^^^
reply <text>
^^^^^^^^^^^^
Replies with *<text>*. Equivalent to the alias, 'echo $nick: $1'. Replies with *<text>*. Equivalent to the alias, 'echo $nick: $1'.

83
use/plugins/rss.rst
View File

@ -4,70 +4,69 @@
The RSS plugin The RSS plugin
============== ==============
.. _command-info: Reading
-------
info <url|feed> .. _command-rss-info:
^^^^^^^^^^^^^^^
rss info <url|feed>
^^^^^^^^^^^^^^^^^^^
Returns information from the given RSS feed, namely the title, Returns information from the given RSS feed, namely the title,
URL, description, and last update date, if available. URL, description, and last update date, if available.
.. _command-rss-announce-list:
.. _command-remove: rss announce list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
remove <name>
^^^^^^^^^^^^^
Removes the command for looking up RSS feeds at *<name>* from
this plugin.
.. _command-add:
add <name> <url>
^^^^^^^^^^^^^^^^
Adds a command to this plugin that will look up the RSS feed at the
given URL.
.. _command-announce-list:
announce list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the list of feeds announced in *<channel>*. *<channel>* is Returns the list of feeds announced in *<channel>*. *<channel>* is
only necessary if the message isn't sent in the channel itself. only necessary if the message isn't sent in the channel itself.
.. _command-rss-rss:
.. _command-announce-remove: rss rss <url> [<number of headlines>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
announce remove [<channel>] <name|url> [<name|url> ...] Gets the title components of the given RSS feed.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If *<number of headlines>* is given, return only that many headlines.
Administration
--------------
.. _command-rss-remove:
rss remove <name>
^^^^^^^^^^^^^^^^^
Removes the command for looking up RSS feeds at *<name>* from
this plugin.
.. _command-rss-add:
rss add <name> <url>
^^^^^^^^^^^^^^^^^^^^
Adds a command to this plugin that will look up the RSS feed at the
given URL.
.. _command-rss-announce-remove:
rss announce remove [<channel>] <name|url> [<name|url> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the list of feeds from the current list of announced feeds Removes the list of feeds from the current list of announced feeds
in *<channel>*. Valid feeds include the names of registered feeds as in *<channel>*. Valid feeds include the names of registered feeds as
well as URLs for RSS feeds. *<channel>* is only necessary if the well as URLs for RSS feeds. *<channel>* is only necessary if the
message isn't sent in the channel itself. message isn't sent in the channel itself.
.. _command-rss-announce-add:
.. _command-announce-add: rss announce add [<channel>] <name|url> [<name|url> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
announce add [<channel>] <name|url> [<name|url> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds the list of feeds to the current list of announced feeds in Adds the list of feeds to the current list of announced feeds in
*<channel>*. Valid feeds include the names of registered feeds as *<channel>*. Valid feeds include the names of registered feeds as
well as URLs for RSS feeds. *<channel>* is only necessary if the well as URLs for RSS feeds. *<channel>* is only necessary if the
message isn't sent in the channel itself. message isn't sent in the channel itself.
.. _command-rss:
rss <url> [<number of headlines>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gets the title components of the given RSS feed.
If *<number of headlines>* is given, return only that many headlines.

35
use/plugins/scheduler.rst
View File

@ -4,36 +4,27 @@
The Scheduler plugin The Scheduler plugin
==================== ====================
.. _command-repeat: .. _command-scheduler-repeat:
repeat <name> <seconds> <command> scheduler repeat <name> <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Schedules the command *<command>* to run every *<seconds>* seconds, Schedules the command *<command>* to run every *<seconds>* seconds,
starting now (i.e., the command runs now, and every *<seconds>* seconds starting now (i.e., the command runs now, and every *<seconds>* seconds
thereafter). *<name>* is a name by which the command can be thereafter). *<name>* is a name by which the command can be
unscheduled. unscheduled.
.. _command-scheduler-list:
.. _command-die: scheduler list
^^^^^^^^^^^^^^
die
^^^^
.. _command-list:
list
^^^^
Lists the currently scheduled events. Lists the currently scheduled events.
.. _command-scheduler-add:
.. _command-add: scheduler add <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
add <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^
Schedules the command string *<command>* to run *<seconds>* seconds in the Schedules the command string *<command>* to run *<seconds>* seconds in the
future. For example, 'scheduler add [seconds 30m] "echo [cpu]"' will 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 command was given in (with no prefixed nick, a consequence of using
echo). Do pay attention to the quotes in that example. echo). Do pay attention to the quotes in that example.
.. _command-scheduler-remove:
.. _command-remove: scheduler remove <id>
^^^^^^^^^^^^^^^^^^^^^
remove <id>
^^^^^^^^^^^
Removes the event scheduled with id *<id>* from the schedule. Removes the event scheduled with id *<id>* from the schedule.

42
use/plugins/seen.rst
View File

@ -4,10 +4,10 @@
The Seen plugin The Seen plugin
=============== ===============
.. _command-user: .. _command-seen-user:
user [<channel>] <name> seen user [<channel>] <name>
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last time *<name>* was seen and what *<name>* was last seen Returns the last time *<name>* was seen and what *<name>* was last seen
saying. This looks up *<name>* in the user seen database, which means saying. This looks up *<name>* in the user seen database, which means
@ -15,21 +15,19 @@ that it could be any nick recognized as user *<name>* that was seen.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-seen-seen:
.. _command-seen: seen seen [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
seen [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^
Returns the last time *<nick>* was seen and what *<nick>* was last seen Returns the last time *<nick>* was seen and what *<nick>* was last seen
saying. *<channel>* is only necessary if the message isn't sent on the saying. *<channel>* is only necessary if the message isn't sent on the
channel itself. *<nick>* may contain * as a wildcard. channel itself. *<nick>* may contain * as a wildcard.
.. _command-seen-any:
.. _command-any: seen any [<channel>] [--user <name>] [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
any [<channel>] [--user <name>] [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last time *<nick>* was seen and what *<nick>* was last seen Returns the last time *<nick>* was seen and what *<nick>* was last seen
doing. This includes any form of activity, instead of just PRIVMSGs. doing. This includes any form of activity, instead of just PRIVMSGs.
@ -38,28 +36,18 @@ If *<nick>* isn't specified, returns the last activity seen in
and returns the last time user was active in *<channel>*. *<channel>* is and returns the last time user was active in *<channel>*. *<channel>* is
only necessary if the message isn't sent on the channel itself. only necessary if the message isn't sent on the channel itself.
.. _command-seen-last:
.. _command-last: seen last [<channel>]
^^^^^^^^^^^^^^^^^^^^^
last [<channel>]
^^^^^^^^^^^^^^^^
Returns the last thing said in *<channel>*. *<channel>* is only necessary Returns the last thing said in *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself. if the message isn't sent in the channel itself.
.. _command-seen-since:
.. _command-die: seen since [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
die
^^^^
.. _command-since:
since [<channel>] <nick>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns the messages since *<nick>* last left the channel. Returns the messages since *<nick>* last left the channel.

92
use/plugins/services.rst
View File

@ -4,92 +4,76 @@
The Services plugin The Services plugin
=================== ===================
.. _command-disabled: NickServ
--------
disabled .. _command-services-identify:
^^^^^^^^^
services identify
^^^^^^^^^^^^^^^^^
.. _command-identify:
identify
^^^^^^^^
Identifies with NickServ using the current nick. Identifies with NickServ using the current nick.
.. _command-services-nicks:
.. _command-nicks: services nicks
^^^^^^^^^^^^^^
nicks
^^^^^
Returns the nicks that this plugin is configured to identify and ghost Returns the nicks that this plugin is configured to identify and ghost
with. with.
.. _command-services-password:
.. _command-unban: services password <nick> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
unban [<channel>] Sets the NickServ password for *<nick>* to *<password>*. If *<password>* is
^^^^^^^^^^^^^^^^^ not given, removes *<nick>* from the configured nicks.
.. _command-services-ghost:
services ghost [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^
Ghosts the bot's given nick and takes it. If no nick is given,
ghosts the bot's configured nick and takes it.
ChanServ
--------
.. _command-services-unban:
services unban [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Attempts to get unbanned by ChanServ in *<channel>*. *<channel>* is only Attempts to get unbanned by ChanServ in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself, but chances 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 are, if you need this command, you're not sending it in the channel
itself. itself.
.. _command-services-invite:
.. _command-reset: services invite [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
reset
^^^^^^
.. _command-invite:
invite [<channel>]
^^^^^^^^^^^^^^^^^^
Attempts to get invited by ChanServ to *<channel>*. *<channel>* is only Attempts to get invited by ChanServ to *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself, but chances 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 are, if you need this command, you're not sending it in the channel
itself. itself.
.. _command-services-voice:
.. _command-password: services voice [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
password <nick> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the NickServ password for *<nick>* to *<password>*. If *<password>* is
not given, removes *<nick>* from the configured nicks.
.. _command-ghost:
ghost [<nick>]
^^^^^^^^^^^^^^
Ghosts the bot's given nick and takes it. If no nick is given,
ghosts the bot's configured nick and takes it.
.. _command-voice:
voice [<channel>]
^^^^^^^^^^^^^^^^^
Attempts to get voiced by ChanServ in *<channel>*. *<channel>* is only Attempts to get voiced by ChanServ in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself. necessary if the message isn't sent in the channel itself.
.. _command-services-op:
.. _command-op: services op [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
op [<channel>]
^^^^^^^^^^^^^^
Attempts to get opped by ChanServ in *<channel>*. *<channel>* is only Attempts to get opped by ChanServ in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself. necessary if the message isn't sent in the channel itself.

28
use/plugins/shrinkurl.rst
View File

@ -4,34 +4,24 @@
The ShrinkUrl plugin The ShrinkUrl plugin
==================== ====================
.. _command-xrl: .. _command-shrinkurl-xrl:
xrl <url> shrinkurl xrl <url>
^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
Returns an xrl.us version of *<url>*. Returns an xrl.us version of *<url>*.
.. _command-shrinkurl-tiny:
.. _command-die: shrinkurl tiny <url>
^^^^^^^^^^^^^^^^^^^^
die
^^^^
.. _command-tiny:
tiny <url>
^^^^^^^^^^
Returns a TinyURL.com version of *<url>* Returns a TinyURL.com version of *<url>*
.. _command-shrinkurl-ln:
.. _command-ln: shrinkurl ln <url>
^^^^^^^^^^^^^^^^^^
ln <url>
^^^^^^^^
Returns an ln-s.net version of *<url>*. Returns an ln-s.net version of *<url>*.

56
use/plugins/status.rst
View File

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

127
use/plugins/string.rst
View File

@ -4,97 +4,96 @@
The String plugin The String plugin
================= =================
.. _command-soundex: Hashes
------
soundex <string> [<length>] .. _command-string-soundex:
^^^^^^^^^^^^^^^^^^^^^^^^^^^
string soundex <string> [<length>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the Soundex hash to a given length. The length defaults to 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 4, since that's the standard length for a soundex hash. For unlimited
length, use 0. length, use 0.
.. _command-string-sha:
.. _command-xor: string sha <text>
^^^^^^^^^^^^^^^^^
xor <password> <text> Returns the SHA hash of a given string. Read
^^^^^^^^^^^^^^^^^^^^^ http://www.secure-hash-algorithm-md5-sha-1.co.uk/ for more information
about SHA.
Encoding/decoding
-----------------
.. _command-string-xor:
string xor <password> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns *<text>* XOR-encrypted with *<password>*. See Returns *<text>* XOR-encrypted with *<password>*. See
http://www.yoe.org/developer/xor.html for information about XOR http://www.yoe.org/developer/xor.html for information about XOR
encryption. encryption.
.. _command-string-encode:
.. _command-re: string encode <encoding> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
re <regexp> <text> Returns an encoded form of the given text; the valid encodings are
^^^^^^^^^^^^^^^^^^ available in the documentation of the Python codecs module:
*<http://docs.python.org/library/codecs.html#standard-encodings>*.
.. _command-string-decode:
string decode <encoding> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns an un-encoded form of the given text; the valid encodings are
available in the documentation of the Python codecs module:
*<http://docs.python.org/library/codecs.html#standard-encodings>*.
.. _command-string-ord:
string ord <letter>
^^^^^^^^^^^^^^^^^^^
Returns the 8-bit value of *<letter>*.
.. _command-string-chr:
string chr <number>
^^^^^^^^^^^^^^^^^^^
Returns the character associated with the 8-bit value *<number>*
Miscellaneous
-------------
.. _command-string-re:
string re <regexp> <text>
^^^^^^^^^^^^^^^^^^^^^^^^^
If *<regexp>* is of the form m/regexp/flags, returns the portion of If *<regexp>* is of the form m/regexp/flags, returns the portion of
*<text>* that matches the regexp. If *<regexp>* is of the form *<text>* that matches the regexp. If *<regexp>* is of the form
s/regexp/replacement/flags, returns the result of applying such a s/regexp/replacement/flags, returns the result of applying such a
regexp to *<text>*. regexp to *<text>*.
.. _command-string-levenshtein:
.. _command-levenshtein: string levenshtein <string1> <string2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
levenshtein <string1> <string2>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the levenshtein distance (also known as the "edit distance" Returns the levenshtein distance (also known as the "edit distance"
between *<string1>* and *<string2>*) between *<string1>* and *<string2>*)
.. _command-string-len:
.. _command-decode: string len <text>
^^^^^^^^^^^^^^^^^
decode <encoding> <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns an un-encoded form of the given text; the valid encodings are
available in the documentation of the Python codecs module:
*<http://docs.python.org/library/codecs.html#standard-encodings>*.
.. _command-sha:
sha <text>
^^^^^^^^^^
Returns the SHA hash of a given string. Read
http://www.secure-hash-algorithm-md5-sha-1.co.uk/ for more information
about SHA.
.. _command-chr:
chr <number>
^^^^^^^^^^^^
Returns the character associated with the 8-bit value *<number>*
.. _command-len:
len <text>
^^^^^^^^^^
Returns the length of *<text>*. Returns the length of *<text>*.
.. _command-encode:
encode <encoding> <text>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns an encoded form of the given text; the valid encodings are
available in the documentation of the Python codecs module:
*<http://docs.python.org/library/codecs.html#standard-encodings>*.
.. _command-ord:
ord <letter>
^^^^^^^^^^^^
Returns the 8-bit value of *<letter>*.

7
use/plugins/success.rst
View File

@ -4,10 +4,3 @@
The Success plugin The Success plugin
================== ==================
.. _command-die:
die
^^^^

82
use/plugins/time.rst
View File

@ -4,19 +4,47 @@
The Time plugin The Time plugin
=============== ===============
.. _command-ctime: Relative time
-------------
ctime [<seconds since epoch>] .. _command-time-ctime:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
time ctime [<seconds since epoch>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the ctime for *<seconds since epoch>*, or the current ctime if Returns the ctime for *<seconds since epoch>*, or the current ctime if
no *<seconds since epoch>* is given. no *<seconds since epoch>* is given.
.. _command-time-time:
.. _command-seconds: time time [<format>] [<seconds since epoch>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
seconds [<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s] Returns the current time in *<format>* format, or, if *<format>* is not
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ given, uses the configurable format for the current channel. If no
*<seconds since epoch>* time is given, the current time is used.
.. _command-time-elapsed:
time elapsed <seconds>
^^^^^^^^^^^^^^^^^^^^^^
Returns a pretty string that is the amount of time represented by
*<seconds>*.
time until <time string>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns the number of seconds until *<time string>*.
Absolute time
-------------
.. _command-time-seconds:
time seconds [<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the number of seconds in the number of *<years>*, *<weeks>*, Returns the number of seconds in the number of *<years>*, *<weeks>*,
*<days>*, *<hours>*, *<minutes>*, and *<seconds>* given. An example usage is *<days>*, *<hours>*, *<minutes>*, and *<seconds>* given. An example usage is
@ -24,48 +52,20 @@ Returns the number of seconds in the number of *<years>*, *<weeks>*,
Useful for scheduling events at a given number of seconds in the Useful for scheduling events at a given number of seconds in the
future. future.
.. _command-time-at:
.. _command-time: time at <time string>
^^^^^^^^^^^^^^^^^^^^^
time [<format>] [<seconds since epoch>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the current time in *<format>* format, or, if *<format>* is not
given, uses the configurable format for the current channel. If no
*<seconds since epoch>* time is given, the current time is used.
.. _command-elapsed:
elapsed <seconds>
^^^^^^^^^^^^^^^^^
Returns a pretty string that is the amount of time represented by
*<seconds>*.
.. _command-at:
at <time string>
^^^^^^^^^^^^^^^^
Returns the number of seconds since epoch *<time string>* is. Returns the number of seconds since epoch *<time string>* is.
*<time string>* can be any number of natural formats; just try something *<time string>* can be any number of natural formats; just try something
and see if it will work. and see if it will work.
.. _command-time-tztime:
.. _command-tztime: time tztime <region>/<city>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
tztime <region>/<city>
^^^^^^^^^^^^^^^^^^^^^^
Takes a city and its region, and returns the locale time. Takes a city and its region, and returns the locale time.
.. _command-until: .. _command-time-until:
until <time string>
^^^^^^^^^^^^^^^^^^^
Returns the number of seconds until *<time string>*.

91
use/plugins/todo.rst
View File

@ -4,64 +4,57 @@
The Todo plugin The Todo plugin
=============== ===============
.. _command-die: Reading
-------
die .. _command-todo-todo:
^^^^
todo todo [<username>] [<task id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-search:
search [--{regexp} <value>] [<glob> <glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches your todos for tasks matching *<glob>*. If *--regexp* is given,
its associated value is taken as a regexp and matched against the
tasks.
.. _command-remove:
remove <task id> [<task id> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes *<task id>* from your personal todo list.
.. _command-add:
add [--priority=<num>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<text>* as a task in your own personal todo list. The optional
priority argument allows you to set a task as a high or low priority.
Any integer is valid.
.. _command-setpriority:
setpriority <id> <priority>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the priority of the todo with the given id to the specified value.
.. _command-todo:
todo [<username>] [<task id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Retrieves a task for the given task id. If no task id is given, it Retrieves a task for the given task id. If no task id is given, it
will return a list of task ids that that user has added to their todo will return a list of task ids that that user has added to their todo
list. list.
.. _command-todo-search:
.. _command-change: todo search [--{regexp} <value>] [<glob> <glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
change <task id> <regexp> Searches your todos for tasks matching *<glob>*. If *--regexp* is given,
^^^^^^^^^^^^^^^^^^^^^^^^^ its associated value is taken as a regexp and matched against the
tasks.
Editing
-------
.. _command-todo-add:
todo add [--priority=<num>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<text>* as a task in your own personal todo list. The optional
priority argument allows you to set a task as a high or low priority.
Any integer is valid.
.. _command-todo-remove:
todo remove <task id> [<task id> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes *<task id>* from your personal todo list.
.. _command-todo-setpriority:
todo setpriority <id> <priority>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the priority of the todo with the given id to the specified value.
.. _command-todo-change:
todo change <task id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Modify the task with the given id using the supplied regexp. Modify the task with the given id using the supplied regexp.

267
use/plugins/topic.rst
View File

@ -4,143 +4,94 @@
The Topic plugin The Topic plugin
================ ================
.. _command-restore: Getting
-------
restore [<channel>] .. _command-topic-topic:
^^^^^^^^^^^^^^^^^^^
topic topic [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^
Returns the topic for *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-topic-get:
topic get [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns topic number *<number>* from *<channel>*. *<number>* is a one-based
index into the topics. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-topic-list:
topic list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Returns a list of the topics in *<channel>*, prefixed by their indexes.
Mostly useful for topic reordering. *<channel>* is only necessary if the
message isn't sent in the channel itself.
Defining
--------
.. _command-topic-restore:
topic restore [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
Restores the topic to the last topic set by the bot. *<channel>* is only Restores the topic to the last topic set by the bot. *<channel>* is only
necessary if the message isn't sent in the channel itself. necessary if the message isn't sent in the channel itself.
.. _command-topic-set:
.. _command-set: topic set [<channel>] [<number>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
set [<channel>] [<number>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the topic *<number>* to be *<text>*. If no *<number>* is given, this Sets the topic *<number>* to be *<text>*. If no *<number>* is given, this
sets the entire topic. *<channel>* is only necessary if the message sets the entire topic. *<channel>* is only necessary if the message
isn't sent in the channel itself. isn't sent in the channel itself.
.. _command-topic-replace:
.. _command-shuffle: topic replace [<channel>] <number> <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
shuffle [<channel>]
^^^^^^^^^^^^^^^^^^^
Shuffles the topics in *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-lock:
lock [<channel>]
^^^^^^^^^^^^^^^^
Locks the topic (sets the mode +t) in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-replace:
replace [<channel>] <number> <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replaces topic *<number>* with *<topic>*. Replaces topic *<number>* with *<topic>*.
.. _command-topic-fit:
.. _command-topic: topic fit [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
topic [<channel>]
^^^^^^^^^^^^^^^^^
Returns the topic for *<channel>*. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-unlock:
unlock [<channel>]
^^^^^^^^^^^^^^^^^^
Unlocks the topic (sets the mode +t) in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-redo:
redo [<channel>]
^^^^^^^^^^^^^^^^
Undoes the last undo. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-fit:
fit [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^
Adds *<topic>* to the topics for *<channel>*. If the topic is too long Adds *<topic>* to the topics for *<channel>*. If the topic is too long
for the server, topics will be popped until there is enough room. for the server, topics will be popped until there is enough room.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.
.. _command-topic-add:
.. _command-swap: topic add [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
swap [<channel>] <first topic number> <second topic number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Swaps the order of the first topic number and the second topic number.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-reorder:
reorder [<channel>] <number> [<number> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Reorders the topics from *<channel>* in the order of the specified
*<number>* arguments. *<number>* is a one-based index into the topics.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
.. _command-get:
get [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^
Returns topic number *<number>* from *<channel>*. *<number>* is a one-based
index into the topics. *<channel>* is only necessary if the message
isn't sent in the channel itself.
.. _command-undo:
undo [<channel>]
^^^^^^^^^^^^^^^^
Restores the topic to the one previous to the last topic command that
set it. *<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-add:
add [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^
Adds *<topic>* to the topics for *<channel>*. *<channel>* is only necessary Adds *<topic>* to the topics for *<channel>*. *<channel>* is only necessary
if the message isn't sent in the channel itself. if the message isn't sent in the channel itself.
.. _command-topic-remove:
.. _command-change: topic remove [<channel>] <number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
change [<channel>] <number> <regexp> Removes topic *<number>* from the topic for *<channel>* Topics are
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ numbered starting from 1; you can also use negative indexes to refer
to topics starting the from the end of the topic. *<channel>* is only
necessary if the message isn't sent in the channel itself.
.. _command-topic-change:
topic change [<channel>] <number> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes the topic number *<number>* on *<channel>* according to the regular Changes the topic number *<number>* on *<channel>* according to the regular
expression *<regexp>*. *<number>* is the one-based index into the topics; expression *<regexp>*. *<number>* is the one-based index into the topics;
@ -148,61 +99,97 @@ expression *<regexp>*. *<number>* is the one-based index into the topics;
s/regexp/replacement/flags. *<channel>* is only necessary if the message s/regexp/replacement/flags. *<channel>* is only necessary if the message
isn't sent in the channel itself. isn't sent in the channel itself.
.. _command-topic-insert:
.. _command-insert: topic insert [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
insert [<channel>] <topic>
^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<topic>* to the topics for *<channel>* at the beginning of the topics Adds *<topic>* to the topics for *<channel>* at the beginning of the topics
currently on *<channel>*. *<channel>* is only necessary if the message currently on *<channel>*. *<channel>* is only necessary if the message
isn't sent in the channel itself. isn't sent in the channel itself.
.. _command-topic-default:
.. _command-default: topic default [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^
default [<channel>]
^^^^^^^^^^^^^^^^^^^
Sets the topic in *<channel>* to the default topic for *<channel>*. The Sets the topic in *<channel>* to the default topic for *<channel>*. The
default topic for a channel may be configured via the configuration default topic for a channel may be configured via the configuration
variable supybot.plugins.Topic.default. variable :ref:`supybot.plugins.Topic.default.`
Re-ordering
-----------
.. _command-die: .. _command-topic-shuffle:
die topic shuffle [<channel>]
^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
Shuffles the topics in *<channel>*. *<channel>* is only necessary if the
.. _command-list:
list [<channel>]
^^^^^^^^^^^^^^^^
Returns a list of the topics in *<channel>*, prefixed by their indexes.
Mostly useful for topic reordering. *<channel>* is only necessary if the
message isn't sent in the channel itself. message isn't sent in the channel itself.
.. _command-topic-reorder:
.. _command-remove: topic reorder [<channel>] <number> [<number> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
remove [<channel>] <number> Reorders the topics from *<channel>* in the order of the specified
^^^^^^^^^^^^^^^^^^^^^^^^^^^ *<number>* arguments. *<number>* is a one-based index into the topics.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
Removes topic *<number>* from the topic for *<channel>* Topics are .. _command-topic-swap:
numbered starting from 1; you can also use negative indexes to refer
to topics starting the from the end of the topic. *<channel>* is only topic swap [<channel>] <first topic number> <second topic number>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Swaps the order of the first topic number and the second topic number.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
Locking
-------
.. _command-topic-lock:
topic lock [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Locks the topic (sets the mode +t) in *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself. necessary if the message isn't sent in the channel itself.
.. _command-topic-unlock:
.. _command-separator: topic unlock [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
separator [<channel>] <separator> Unlocks the topic (sets the mode +t) in *<channel>*. *<channel>* is only
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ necessary if the message isn't sent in the channel itself.
Utilities
---------
.. _command-topic-undo:
topic undo [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Restores the topic to the one previous to the last topic command that
set it. *<channel>* is only necessary if the message isn't sent in the
channel itself.
.. _command-topic-redo:
topic redo [<channel>]
^^^^^^^^^^^^^^^^^^^^^^
Undoes the last undo. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-topic-separator:
topic separator [<channel>] <separator>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the topic separator for *<channel>* to *<separator>* Converts the Sets the topic separator for *<channel>* to *<separator>* Converts the
current topic appropriately. current topic appropriately.

101
use/plugins/unix.rst
View File

@ -4,90 +4,85 @@
The Unix plugin The Unix plugin
=============== ===============
.. _command-fortune: Utitilies
---------
fortune .. _command-unix-errno:
^^^^^^^
Returns a fortune from the *nix fortune program. unix errno <error number or code>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-errno:
errno <error number or code>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the number of an errno code, or the errno code of a number. Returns the number of an errno code, or the errno code of a number.
.. _command-unix-spell:
.. _command-spell: unix spell <word>
^^^^^^^^^^^^^^^^^
spell <word>
^^^^^^^^^^^^
Returns the result of passing *<word>* to aspell/ispell. The results Returns the result of passing *<word>* to aspell/ispell. The results
shown are sorted from best to worst in terms of being a likely match shown are sorted from best to worst in terms of being a likely match
for the spelling of *<word>*. for the spelling of *<word>*.
.. _command-unix-pid:
.. _command-pid: unix pid
^^^^^^^^
pid
^^^
Returns the current pid of the process for this Supybot. Returns the current pid of the process for this Supybot.
.. _command-unix-call:
.. _command-call: unix call <command to call with any arguments>
call <command to call with any arguments> Calls any command available on the system, and returns its output.
Calls any command available on the system, and returns its output. Requires owner capability.
Requires owner capability. Note that being restricted to owner, this command does not do any
Note that being restricted to owner, this command does not do any sanity checking on input/output. So it is up to you to make sure
sanity checking on input/output. So it is up to you to make sure you don't run anything that will spamify your channel or that
you don't run anything that will spamify your channel or that will bring your machine to its knees.
will bring your machine to its knees.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-unix-crypt:
unix crypt <password> [<salt>]
.. _command-wtf: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
wtf [is] <something>
^^^^^^^^^^^^^^^^^^^^
Returns wtf *<something>* is. 'wtf' is a *nix command that first
appeared in NetBSD 1.5. In most *nices, it's available in some sort
of 'bsdgames' package.
.. _command-crypt:
crypt <password> [<salt>]
^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the resulting of doing a crypt() on *<password>* If *<salt>* is Returns the resulting of doing a crypt() on *<password>* If *<salt>* is
not given, uses a random salt. If running on a glibc2 system, not given, uses a random salt. If running on a glibc2 system,
prepending '$1$' to your salt will cause crypt to return an MD5sum prepending '$1$' to your salt will cause crypt to return an MD5sum
based crypt rather than the standard DES based crypt. based crypt rather than the standard DES based crypt.
.. _command-unix-progstats:
.. _command-progstats: unix progstats
^^^^^^^^^^^^^^
progstats Returns various unix-y information on the running :ref:`supybot process.`
^^^^^^^^^
Returns various unix-y information on the running supybot process. .. _command-unix-ping:
unix ping [--c <count>] [--i <interval>] [--t <ttl>] [--W <timeout>] <host or ip>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-ping: Sends an ICMP echo request to the specified host.
The arguments correspond with those listed in ping(8). --c is
limited to 10 packets or less (default is 5). --i is limited to 5
or less. --W is limited to 10 or less.
ping [--c <count>] [--i <interval>] [--t <ttl>] [--W <timeout>] <host or ip> Fun
Sends an ICMP echo request to the specified host. ---
The arguments correspond with those listed in ping(8). --c is
limited to 10 packets or less (default is 5). --i is limited to 5
or less. --W is limited to 10 or less.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-unix-fortune:
unix fortune
^^^^^^^^^^^^
Returns a fortune from the \*nix fortune program.
.. _command-unix-wtf:
unix wtf [is] <something>
^^^^^^^^^^^^^^^^^^^^^^^^^
Returns wtf *<something>* is. 'wtf' is a \*nix command that first
appeared in NetBSD 1.5. In most \*nices, it's available in some sort
of 'bsdgames' package.

14
use/plugins/url.rst
View File

@ -4,19 +4,18 @@
The URL plugin The URL plugin
============== ==============
.. _command-stats: .. _command-url-stats:
stats [<channel>] url stats [<channel>]
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
Returns the number of URLs in the URL database. *<channel>* is only Returns the number of URLs in the URL database. *<channel>* is only
required if the message isn't sent in the channel itself. required if the message isn't sent in the channel itself.
.. _command-url-last:
.. _command-last: url last [<channel>] [--{from,with,without,near,proto} <value>] [--nolimit]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
last [<channel>] [--{from,with,without,near,proto} <value>] [--nolimit]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the last URL matching the given criteria. *--from* is from whom Gives the last URL matching the given criteria. *--from* is from whom
the URL came; *--proto* is the protocol the URL used; *--with* is something the URL came; *--proto* is the protocol the URL used; *--with* is something
@ -26,4 +25,3 @@ given, returns all the URLs that are found. to just the URL.
*<channel>* is only necessary if the message isn't sent in the channel *<channel>* is only necessary if the message isn't sent in the channel
itself. itself.

112
use/plugins/user.rst
View File

@ -4,19 +4,18 @@
The User plugin The User plugin
=============== ===============
.. _command-username: .. _command-user-username:
username <hostmask|nick> user username <hostmask|nick>
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the username of the user specified by *<hostmask>* or *<nick>* if Returns the username of the user specified by *<hostmask>* or *<nick>* if
the user is registered. the user is registered.
.. _command-user-set-password:
.. _command-set-password: user set password [<name>] <old password> <new password>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
set password [<name>] <old password> <new password>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the new password for the user specified by *<name>* to *<new Sets the new password for the user specified by *<name>* to *<new
password>*. Obviously this message must be sent to the bot password>*. Obviously this message must be sent to the bot
@ -24,11 +23,10 @@ privately (not in a channel). If the requesting user is an owner
user (and the user whose password is being changed isn't that same user (and the user whose password is being changed isn't that same
owner user), then *<old password>* needn't be correct. owner user), then *<old password>* needn't be correct.
.. _command-user-set-secure:
.. _command-set-secure: user set secure <password> [<True|False>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
set secure <password> [<True|False>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the secure flag on the user of the person sending the message. Sets the secure flag on the user of the person sending the message.
Requires that the person's hostmask be in the list of hostmasks for Requires that the person's hostmask be in the list of hostmasks for
@ -37,38 +35,34 @@ secure flag is set, the user *must* identify before he can be
recognized. If a specific True/False value is not given, it recognized. If a specific True/False value is not given, it
inverts the current value. inverts the current value.
.. _command-user-stats:
.. _command-stats: user stats
^^^^^^^^^^
stats
^^^^^
Returns some statistics on the user database. Returns some statistics on the user database.
.. _command-user-hostmask-hostmask:
.. _command-hostmask-hostmask: user hostmask hostmask [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
hostmask hostmask [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the hostmask of *<nick>*. If *<nick>* isn't given, return the Returns the hostmask of *<nick>*. If *<nick>* isn't given, return the
hostmask of the person giving the command. hostmask of the person giving the command.
.. _command-user-hostmask-list:
.. _command-hostmask-list: user hostmask list [<name>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
hostmask list [<name>]
^^^^^^^^^^^^^^^^^^^^^^
Returns the hostmasks of the user specified by *<name>*; if *<name>* Returns the hostmasks of the user specified by *<name>*; if *<name>*
isn't specified, returns the hostmasks of the user calling the isn't specified, returns the hostmasks of the user calling the
command. command.
.. _command-user-hostmask-add:
.. _command-hostmask-add: user hostmask add [<name>] [<hostmask>] [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
hostmask add [<name>] [<hostmask>] [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds the hostmask *<hostmask>* to the user specified by *<name>*. The Adds the hostmask *<hostmask>* to the user specified by *<name>*. The
*<password>* may only be required if the user is not recognized by *<password>* may only be required if the user is not recognized by
@ -79,11 +73,10 @@ given, it defaults to your currently identified name. This message
must be sent to the bot privately (not on a channel) since it may must be sent to the bot privately (not on a channel) since it may
contain a password. contain a password.
.. _command-user-hostmask-remove:
.. _command-hostmask-remove: user hostmask remove <name> <hostmask> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
hostmask remove <name> <hostmask> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the hostmask *<hostmask>* from the record of the user Removes the hostmask *<hostmask>* from the record of the user
specified by *<name>*. If the hostmask given is 'all' then all specified by *<name>*. If the hostmask given is 'all' then all
@ -92,20 +85,18 @@ the user is not recognized by his hostmask. This message must be
sent to the bot privately (not on a channel) since it may contain a sent to the bot privately (not on a channel) since it may contain a
password. password.
.. _command-user-unregister:
.. _command-unregister: user unregister <name> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
unregister <name> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unregisters *<name>* from the user database. If the user giving this Unregisters *<name>* from the user database. If the user giving this
command is an owner user, the password is not necessary. command is an owner user, the password is not necessary.
.. _command-user-register:
.. _command-register: user register <name> <password>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
register <name> <password>
^^^^^^^^^^^^^^^^^^^^^^^^^^
Registers *<name>* with the given password *<password>* and the current Registers *<name>* with the given password *<password>* and the current
hostmask of the person registering. You shouldn't register twice; if hostmask of the person registering. You shouldn't register twice; if
@ -115,63 +106,56 @@ user, or use the identify command to identify just for a session.
This command (and all other commands that include a password) must be This command (and all other commands that include a password) must be
sent to the bot privately, not in a channel. sent to the bot privately, not in a channel.
.. _command-user-list:
.. _command-list: user list [--capability=<capability>] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
list [--capability=<capability>] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the valid registered usernames matching *<glob>*. If *<glob>* is Returns the valid registered usernames matching *<glob>*. If *<glob>* is
not given, returns all registered usernames. not given, returns all registered usernames.
.. _command-user-capabilities:
.. _command-capabilities: user capabilities [<name>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
capabilities [<name>]
^^^^^^^^^^^^^^^^^^^^^
Returns the capabilities of the user specified by *<name>*; if *<name>* Returns the capabilities of the user specified by *<name>*; if *<name>*
isn't specified, returns the capabilities of the user calling the isn't specified, returns the capabilities of the user calling the
command. command.
.. _command-user-unidentify:
.. _command-unidentify: user unidentify
^^^^^^^^^^^^^^^
unidentify
^^^^^^^^^^
Un-identifies you. Note that this may not result in the desired Un-identifies you. Note that this may not result in the desired
effect of causing the bot not to recognize you anymore, since you may effect of causing the bot not to recognize you anymore, since you may
have added hostmasks to your user that can cause the bot to continue to have added hostmasks to your user that can cause the bot to continue to
recognize you. recognize you.
.. _command-user-identify:
.. _command-identify: user identify <name> <password>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
identify <name> <password>
^^^^^^^^^^^^^^^^^^^^^^^^^^
Identifies the user as *<name>*. This command (and all other Identifies the user as *<name>*. This command (and all other
commands that include a password) must be sent to the bot privately, commands that include a password) must be sent to the bot privately,
not in a channel. not in a channel.
.. _command-user-whoami:
.. _command-whoami: user whoami
^^^^^^^^^^^
whoami
^^^^^^
Returns the name of the user calling the command. Returns the name of the user calling the command.
.. _command-user-changename:
.. _command-changename: user changename <name> <new name> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
changename <name> <new name> [<password>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Changes your current user database name to the new name given. Changes your current user database name to the new name given.
*<password>* is only necessary if the user isn't recognized by hostmask. *<password>* is only necessary if the user isn't recognized by hostmask.
This message must be sent to the bot privately (not on a channel) since This message must be sent to the bot privately (not on a channel) since
it may contain a password. it may contain a password.

56
use/plugins/utilities.rst
View File

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

73
use/plugins/web.rst
View File

@ -4,73 +4,74 @@
The Web plugin The Web plugin
============== ==============
.. _command-urlunquote: HTTP
----
urlunquote <text> .. _command-web-urlunquote:
^^^^^^^^^^^^^^^^^
web urlunquote <text>
^^^^^^^^^^^^^^^^^^^^^
Returns the text un-URL quoted. Returns the text un-URL quoted.
.. _command-web-urlquote:
.. _command-netcraft: web urlquote <text>
^^^^^^^^^^^^^^^^^^^
netcraft <hostname|ip>
^^^^^^^^^^^^^^^^^^^^^^
Returns Netcraft.com's determination of what operating system and
webserver is running on the host given.
.. _command-urlquote:
urlquote <text>
^^^^^^^^^^^^^^^
Returns the URL quoted form of the text. Returns the URL quoted form of the text.
.. _command-web-size:
.. _command-size: web size <url>
^^^^^^^^^^^^^^
size <url>
^^^^^^^^^^
Returns the Content-Length header of *<url>*. Only HTTP urls are valid, Returns the Content-Length header of *<url>*. Only HTTP urls are valid,
of course. of course.
HTML
----
.. _command-title: .. _command-web-title:
title <url> web title <url>
^^^^^^^^^^^ ^^^^^^^^^^^^^^^
Returns the HTML *<title>*...*</title>* of a URL. Returns the HTML *<title>*...*</title>* of a URL.
.. _command-web-doctype:
.. _command-doctype: web doctype <url>
^^^^^^^^^^^^^^^^^
doctype <url>
^^^^^^^^^^^^^
Returns the DOCTYPE string of *<url>*. Only HTTP urls are valid, of Returns the DOCTYPE string of *<url>*. Only HTTP urls are valid, of
course. course.
.. _command-web-headers:
.. _command-headers: web headers <url>
^^^^^^^^^^^^^^^^^
headers <url>
^^^^^^^^^^^^^
Returns the HTTP headers of *<url>*. Only HTTP urls are valid, of Returns the HTTP headers of *<url>*. Only HTTP urls are valid, of
course. course.
Others
------
.. _command-fetch: .. _command-web-netcraft:
fetch <url> web netcraft <hostname|ip>
^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns Netcraft.com's determination of what operating system and
webserver is running on the host given.
.. _command-web-fetch:
web fetch <url>
^^^^^^^^^^^^^^^
Returns the contents of *<url>*, or as much as is configured in Returns the contents of *<url>*, or as much as is configured in
supybot.plugins.Web.fetch.maximum. If that configuration variable is :ref:`supybot.plugins.Web.fetch.maximum.` If that configuration variable is
set to 0, this command will be effectively disabled. set to 0, this command will be effectively disabled.