Add a bunch of plugins from ProgVal/Supybot-plugins, and add configuration doc for others.

This commit is contained in:
Valentin Lorentz 2011-10-29 12:39:38 +02:00
parent f0b2a20305
commit eafcaa63c3
21 changed files with 1413 additions and 93 deletions

View File

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

42
use/plugins/brainfuck.rst Normal file
View File

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

32
use/plugins/coffee.rst Normal file
View File

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

93
use/plugins/debian.rst Normal file
View File

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

99
use/plugins/erepublik.rst Normal file
View File

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

119
use/plugins/eureka.rst Normal file
View File

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

View File

@ -40,3 +40,46 @@ Announce the commits of the GitHub repository called
*<owner>*/*<name>* in the *<channel>*.
*<channel>* defaults to the current channel.
.. _plugin-github-config:
Configuration
-------------
.. _supybot.plugins.GitHub.api:
supybot.plugins.GitHub.api
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.GitHub.api.url:
supybot.plugins.GitHub.api.url
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: http://github.com/api/v2/json
The URL of the GitHub API to use. You probably don't need to edit it, but I let it there, just in case.
.. _supybot.plugins.GitHub.announces:
supybot.plugins.GitHub.announces
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
You shouldn't edit this configuration variable yourself, unless you know what you do. Use '@Github announce add' or '@Github announce remove' instead.
.. _supybot.plugins.GitHub.public:
supybot.plugins.GitHub.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

View File

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

View File

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

View File

@ -39,6 +39,7 @@ Channel-specific plugins
moobotfactoids.rst
protector.rst
topic.rst
webstats.rst
Utilities
@ -49,6 +50,8 @@ Utilities
anonymous.rst
ctcp.rst
debian.rst
goodfrench.rst
later.rst
news.rst
nickcapture.rst
@ -57,8 +60,10 @@ Utilities
rss.rst
seen.rst
services.rst
seeks.rst
shrinkurl.rst
string.rst
wikitrans.rst
Internal tools
===============
@ -67,11 +72,8 @@ Internal tools
:maxdepth: 3
alias.rst
conditional.rst
dunno.rst
format.rst
messageparser.rst
packages.rst
plugindownloader.rst
reply.rst
scheduler.rst
@ -80,12 +82,27 @@ Internal tools
trigger.rst
utilities.rst
Scripting/programming
=====================
.. toctree::
:maxdepth: 3
brainfuck.rst
conditional.rst
messageparser.rst
supyml.rst
supysandbox.rst
Fun
===
.. toctree::
:maxdepth: 3
coffee.rst
erepublik.rst
eureka.rst
filter.rst
games.rst
megahal.rst

View File

@ -4,16 +4,6 @@
The LinkRelay plugin
====================
Highly configurable messages relay between channels.
.. include:: unofficial.inc
.. WARNING::
This plugin exists both in :ref:`repository-progval` and in
:ref:`repository-quantumlemur`. This doc is for the one in ProgVal's,
because quantumlemur's is the same, without this commands.
.. _command-linkrelay-nosubstitute:
linkrelay nosubstitute <regexp>
@ -69,3 +59,163 @@ linkrelay substitute <regexp> <replacement>
Replaces all nicks that matches the *<regexp>* by the *<replacement>*
string.
.. _plugin-linkrelay-config:
Configuration
-------------
.. _supybot.plugins.LinkRelay.color:
supybot.plugins.LinkRelay.color
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will color Relayed PRIVMSGs so as to make the messages easier to read.
.. _supybot.plugins.LinkRelay.hostmasks:
supybot.plugins.LinkRelay.hostmasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the bot will Relay the hostmask of the person joining or parting the channel when he or she joins or parts.
.. _supybot.plugins.LinkRelay.includeNetwork:
supybot.plugins.LinkRelay.includeNetwork
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will include the network in Relayed PRIVMSGs; if you're only Relaying between two networks, it's somewhat redundant, and you may wish to save the space.
.. _supybot.plugins.LinkRelay.nonPrivmsgs:
supybot.plugins.LinkRelay.nonPrivmsgs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: privmsg
Determines whether the bot will use PRIVMSGs (privmsg), NOTICEs (notice), for non-PRIVMSG Relay messages (i.e., joins, parts, nicks, quits, modes, etc.), or whether it won't relay such messages (nothing)
.. _supybot.plugins.LinkRelay.topicSync:
supybot.plugins.LinkRelay.topicSync
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the bot will synchronize topics between networks in the channels it Relays.
.. _supybot.plugins.LinkRelay.colors:
supybot.plugins.LinkRelay.colors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.LinkRelay.colors.info:
supybot.plugins.LinkRelay.colors.info
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 02
Color used for relaying 02.
.. _supybot.plugins.LinkRelay.colors.join:
supybot.plugins.LinkRelay.colors.join
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.kick:
supybot.plugins.LinkRelay.colors.kick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.mode:
supybot.plugins.LinkRelay.colors.mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.nick:
supybot.plugins.LinkRelay.colors.nick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.part:
supybot.plugins.LinkRelay.colors.part
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.quit:
supybot.plugins.LinkRelay.colors.quit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.colors.truncated:
supybot.plugins.LinkRelay.colors.truncated
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: 14
Color used for relaying 14.
.. _supybot.plugins.LinkRelay.public:
supybot.plugins.LinkRelay.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
.. _supybot.plugins.LinkRelay.relays:
supybot.plugins.LinkRelay.relays
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
You shouldn't edit this configuration variable yourself unless you know what you do. Use @LinkRelay {add|remove} instead.
.. _supybot.plugins.LinkRelay.substitutes:
supybot.plugins.LinkRelay.substitutes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
You shouldn't edit this configuration variable yourself unless you know what you do. Use @LinkRelay (no)substitute instead.

View File

@ -1,50 +0,0 @@
.. _plugin-packages:
The Packages plugin
===================
.. _command-packages-info:
packages info [<repository url>] <package> [<version>] [--author-full]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Displays informations about the *<package>*, at the given *<version>*.
*<repository url>* defaults to http://packages.supybot.fr.cr/ and
*<version>* defaults to the latest available.
.. _command-packages-install:
packages install <filename> [--force]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installs the package. If the package has been downloaded with Package,
just give the package name; otherwise, give the full path (including
the extension).
If given, *--force* disables sanity checks (usage is deprecated).
.. _command-packages-search:
packages search [<repository url>] [--name <name>] [--version <version>] [--author <author>] [<description>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches the packages matching the query in the *<repository url>*.
*<repository url>* defaults to http://packages.supybot.fr.cr/
.. _command-packages-checkupdates:
packages checkupdates [<repository url>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Checks for updates for loaded plugins at the *<repository url>*.
*<repository url>* defaults to http://packages.supybot.fr.cr/
.. _command-packages-download:
packages download <package> [--version <version>] [--repo <repository url>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Downloads the *<package>* at the *<repository url>*.
*<version>* defaults to the latest version available.
*<repository url>* defaults to http://packages.supybot.fr.cr/

65
use/plugins/seeks.rst Normal file
View File

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

View File

@ -4,18 +4,27 @@
The Sudo plugin
===============
.. WARNING::
Use this plugin carefully. It may be dangerous with a bad configuration.
.. include:: unofficial.inc
.. _command-sudo-sudo:
sudo sudo <commande> [<arg1> [<arg2> ...]]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Runs the command fellowing the Sudo rules.
Runs the command following the Sudo rules.
.. _command-sudo-remove:
sudo remove <id>
^^^^^^^^^^^^^^^^
Remove a Sudo rule.
.. _command-sudo-fakehostmask:
sudo fakehostmask <hostmask> <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Runs *<command>* as if you were wearing the *<hostmask>*. Of course, usage
of the command is restricted to the owner.
.. _command-sudo-add:
@ -31,10 +40,19 @@ If *<priority>* is not given, it defaults to 0.
The *<hostmask>* defaults to your hostmask.
The *<hostmask>* is only needed if you set an 'allow' rule.
.. _command-sudo-remove:
sudo remove <id>
^^^^^^^^^^^^^^^^
Remove a Sudo rule.
.. _plugin-sudo-config:
Configuration
-------------
.. _supybot.plugins.Sudo.public:
supybot.plugins.Sudo.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

38
use/plugins/supyml.rst Normal file
View File

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

View File

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

View File

@ -4,12 +4,73 @@
The Trigger plugin
==================
.. include:: unofficial.inc
This plugin allows you to run commands triggered by an event.
If you want, for example, trigger a kick when a user join without giving
him the :ref:`op capability <capability-op>`, you need the `Sudo plugin
<plugin-sudo>`.
.. _plugin-trigger-config:
Configuration
-------------
.. _supybot.plugins.Trigger.triggers:
supybot.plugins.Trigger.triggers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Trigger.triggers.join:
supybot.plugins.Trigger.triggers.join
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered by %s
.. _supybot.plugins.Trigger.triggers.notice:
supybot.plugins.Trigger.triggers.notice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered by %s
.. _supybot.plugins.Trigger.triggers.part:
supybot.plugins.Trigger.triggers.part
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered by %s
.. _supybot.plugins.Trigger.triggers.privmsg:
supybot.plugins.Trigger.triggers.privmsg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered by %s
.. _supybot.plugins.Trigger.triggers.connect:
supybot.plugins.Trigger.triggers.connect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
Command triggered on connect. This shouldn't be a Supybot command, but an IRC command (as given to ircquote).
.. _supybot.plugins.Trigger.public:
supybot.plugins.Trigger.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.
`plugin-conditional` may also be useful here.

View File

@ -4,14 +4,6 @@
The Twitter plugin
==================
This plugin provides access to the Twitter API, using OAuth authentication.
You can set a Twitter account for the whole bot, and an account per channel.
This plugin may work with identica/statusnet Twitter-compatible API, but has
not been tested yet.
.. include:: unofficial.inc
.. _command-twitter-friendslist:
twitter friendslist [<channel>] [<user>]
@ -21,10 +13,27 @@ Replies with the friends (i.e. people who one subscribes to) of the
*<user>*. If *<user>* is not given, it defaults to the *<channel>*'s account.
If *<channel>* is not given, it defaults to the current channel.
.. _command-twitter-unfollow:
twitter unfollow [<channel>] <user>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unfollow a specified *<user>*
If *<channel>* is not given, it defaults to the current channel.
.. _command-twitter-replies:
twitter replies [<channel>] [--since <oldest>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with the replies timeline.
If *<channel>* is not given, it defaults to the current channel.
If given, *--since* takes a tweet ID, used as a boundary
.. _command-twitter-timeline:
twitter timeline [<channel>|<user>] [--since <oldest>] [--max <newest>] [--count <number>] [--noretweet]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
twitter timeline [<channel>] [<user>] [--since <oldest>] [--max <newest>] [--count <number>] [--noretweet] [--with-id]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with the timeline of the *<user>*.
If *<user>* is not given, it defaults to the account associated with the
@ -35,6 +44,14 @@ If given, *--count* takes an integer, that stands for the number of
tweets to display.
If *--noretweet* is given, only native user's tweet will be displayed.
.. _command-twitter-follow:
twitter follow [<channel>] <user>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Follow a specified *<user>*
If *<channel>* is not given, it defaults to the current channel.
.. _command-twitter-post:
twitter post [<channel>] <message>
@ -44,3 +61,117 @@ Updates the status of the account associated with the given *<channel>*
to the *<message>*. If *<channel>* is not given, it defaults to the
current channel.
.. _command-twitter-public:
twitter public [<channel>] [--since <oldest>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Replies with the public timeline.
If *<channel>* is not given, it defaults to the current channel.
If given, *--since* takes a tweet ID, used as a boundary
.. _command-twitter-delete:
twitter delete [<channel>] <id>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Delete a specified status with id *<id>*
If *<channel>* is not given, it defaults to the current channel.
.. _plugin-twitter-config:
Configuration
-------------
.. _supybot.plugins.Twitter.accounts:
supybot.plugins.Twitter.accounts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Twitter.accounts.bot:
supybot.plugins.Twitter.accounts.bot
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Twitter.accounts.bot.api:
supybot.plugins.Twitter.accounts.bot.api
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: https://api.twitter.com/1
The URL to the base API URL (by default, it is Twitter.com, but you can use it for twitter-compatible services, such as identica/statusnet.
.. _supybot.plugins.Twitter.accounts.bot.key:
supybot.plugins.Twitter.accounts.bot.key
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
The Twitter Access Token key for the bot's account (running get_access_token.py is a way to get it)
.. _supybot.plugins.Twitter.accounts.bot.secret:
supybot.plugins.Twitter.accounts.bot.secret
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
The Twitter Access Token secret for the bot's account (running get_access_token.py is a way to get it)
.. _supybot.plugins.Twitter.accounts.channel:
supybot.plugins.Twitter.accounts.channel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Twitter.accounts.channel.key:
supybot.plugins.Twitter.accounts.channel.key
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
The Twitter Access Token key for this channel's account (running get_access_token.py is a way to get it)
.. _supybot.plugins.Twitter.accounts.channel.secret:
supybot.plugins.Twitter.accounts.channel.secret
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value:
The Twitter Access Token secret for this channel's account (running get_access_token.py is a way to get it)
.. _supybot.plugins.Twitter.accounts.channel.api:
supybot.plugins.Twitter.accounts.channel.api
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: https://api.twitter.com/1
The URL to the base API URL (by default, it is Twitter.com, but you can use it for twitter-compatible services, such as identica/statusnet.
.. _supybot.plugins.Twitter.public:
supybot.plugins.Twitter.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.

49
use/plugins/webstats.rst Normal file
View File

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

View File

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

30
use/plugins/wikitrans.rst Normal file
View File

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