mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2025-01-11 13:12:35 +01:00
Too many changes to list them.
This commit is contained in:
Valentin Lorentz
parent
bd2fdf30f2
commit
129d61db76
41
contribute/develop.rst
Normal file
41
contribute/develop.rst
Normal file
@ -0,0 +1,41 @@
|
||||
.. _contribute-develop:
|
||||
|
||||
***************************************
|
||||
Contributing to Limnoria as a developer
|
||||
***************************************
|
||||
|
||||
.. NOTE::
|
||||
|
||||
This page is still a draft and is not complete.
|
||||
|
||||
.. _contribute-develop-policy:
|
||||
|
||||
About the policy about repository access
|
||||
========================================
|
||||
|
||||
For the moment, I decided to give write access to my repository to nobody,
|
||||
because I want to check everything that is pushed in it. If someone pushes a
|
||||
bad update, it may be dangerous for users and I do not want that.
|
||||
|
||||
On the other side, I am **very** open to pull requests, that's to say, if you
|
||||
ask me to merge some changes you made, there are 99% changes I will merge this
|
||||
changes.
|
||||
That's why I suggest you to fork my repository on GitHub, make your
|
||||
modifications, and click the "Pull requests" button in my repository.
|
||||
|
||||
Using Git
|
||||
=========
|
||||
|
||||
If you are a developer, I assume that you know how to use Git. If you don't,
|
||||
I suggest you to learn how to use it, at least the basics (clone, checkout,
|
||||
branch, commit, push/pull, add/rm, log, show, reset, revert).
|
||||
|
||||
I learnt how to use Git with an ebook, also available as a real book:
|
||||
`Pro Git`_.
|
||||
|
||||
.. _Pro Git: http://progit.org/book/
|
||||
|
||||
Code style
|
||||
==========
|
||||
|
||||
Read the doc in the source code (docs/STYLE.rst).
|
||||
11
contribute/index.rst
Normal file
11
contribute/index.rst
Normal file
@ -0,0 +1,11 @@
|
||||
.. _contribute-index:
|
||||
|
||||
########################
|
||||
Contributing to Limnoria
|
||||
########################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
develop.rst
|
||||
translate.rst
|
||||
138
contribute/translate.rst
Normal file
138
contribute/translate.rst
Normal file
@ -0,0 +1,138 @@
|
||||
.. highlight:: bash
|
||||
|
||||
.. _contribute-translate:
|
||||
|
||||
********************
|
||||
Translating Limnoria
|
||||
********************
|
||||
|
||||
I already write a `guide on how to translate`_ plugins.
|
||||
So, this page will only explain how to translate the core and push your
|
||||
translations to Limnoria.
|
||||
|
||||
.. _guide on how to translate: https://github.com/ProgVal/Supybot-docs/blob/master/i18n/Limnoria_i18n.pdf?raw=true
|
||||
|
||||
The best way: using Git yourself
|
||||
================================
|
||||
|
||||
As I said in the :ref:`policy about developer's contributions
|
||||
<contribute-develop-policy>`, I don't give write access to my repo for the
|
||||
moment, but I accept pull requests.
|
||||
|
||||
As you are a translator, you don't need to know all the technical details
|
||||
about development, so I write a simplified doc here.
|
||||
|
||||
Cloning the repository
|
||||
----------------------
|
||||
|
||||
You first need an account on `GitHub`_; I think you don't need explaination
|
||||
for that.
|
||||
|
||||
Then, go on `Limnoria repository`_ and click the *Fork* button. This will
|
||||
create you a copy of my repository where you will have write access (and
|
||||
I won't have this write access).
|
||||
|
||||
Then, open a console, and write (replace *YourName* by the name of your
|
||||
GitHub account)::
|
||||
|
||||
git clone git@github.com:YourName/Limnoria.git
|
||||
|
||||
This will create a new directory, called *Limnoria*, where all the code and
|
||||
project history are copied. Now, cd to the directory::
|
||||
|
||||
cd Limnoria/
|
||||
|
||||
Then, you need to checkout the *testing* branch. What does that mean? It means
|
||||
that there is differents stages in Limnoria: all changes are made in testing,
|
||||
and when I think *testing* is stable, I merge it into *master*.
|
||||
So, checking out *testing* means Git will use the code in *testing*, you
|
||||
will translate strings that are in *testing*, and changes you make will be
|
||||
in *testing*. Now, do it::
|
||||
|
||||
git checkout testing
|
||||
|
||||
Git will reply you that it understood what you mean by *testing*.
|
||||
|
||||
Ok, now, you can translate.
|
||||
|
||||
Pushing translations
|
||||
--------------------
|
||||
|
||||
Once you have done some translations (let's say you translated Alias), you
|
||||
have to commit your changes. That mean you tell Git "Ok, I've made some
|
||||
changes, and I want to take a snapshot (either to be able to roll back
|
||||
or to publish your changes).
|
||||
|
||||
First, you need to tell Git what files you want to be committed (let's say
|
||||
you are the Finnish translator, so you updated Alias's fi.po)::
|
||||
|
||||
git add plugins/Alias/locale/fi.po
|
||||
|
||||
Then, you can commit your files. Depending on what you made, you can use
|
||||
one of this commands (not all of them!)::
|
||||
|
||||
git commit -m "Alias: Add l10n-fi."
|
||||
git commit -m "Alias: Update l10n-fi."
|
||||
git commit -m "Alias: Fix l10n-fi."
|
||||
|
||||
By the way, the text that follow -m is a message that will be readed by
|
||||
**humans**, so you can write anything you want, but I think it's better that
|
||||
everybody use the same kind of messages.
|
||||
|
||||
Ok, then, Git knows you have done something. But you didn't send your work on
|
||||
Internet yet. To send it, run::
|
||||
|
||||
git push
|
||||
|
||||
Simple, isn't?
|
||||
|
||||
Now, go back on GitHub, on your forked repository, and click the *Pull request*
|
||||
button. Then, set *testing* on the both side, and run *Update Commit Range*.
|
||||
I will by mailed that you asked me to merge your changes, and I will do it
|
||||
soon.
|
||||
|
||||
Getting updates
|
||||
---------------
|
||||
|
||||
As you may know, I do some updates in Limnoria repository. ;)
|
||||
|
||||
You need to have the latest version of the *messages.pot* files. So, you
|
||||
need to teach Git how to get this updates::
|
||||
|
||||
git remote add progval git://github.com/ProgVal/Limnoria.git
|
||||
|
||||
Now, every time you want to download updates, run::
|
||||
|
||||
git fetch progval
|
||||
git merge progval/testing
|
||||
|
||||
Another way: mailing me your translations
|
||||
=========================================
|
||||
|
||||
I think this is the simplest way for you. You only have to follow the
|
||||
translation guide and send me your .po files by mail.
|
||||
|
||||
You can choose either one of this way to do it.
|
||||
|
||||
Mkaysi's way
|
||||
------------
|
||||
|
||||
Send the fi.po (or whatever the name is)files one by one as an attachment.
|
||||
Don't forget to tell me what plugin it is.
|
||||
|
||||
skizzhg's way
|
||||
-------------
|
||||
|
||||
Do many translations. Put them in a tarball/zipball/whatever (but not a RAR
|
||||
archive, I can't read them because is a f*cking proprietary format).
|
||||
|
||||
I prefer that you choose this architecture:
|
||||
|
||||
* FirstPlugin/locale/it.po
|
||||
* SecondPlugin/locale/it.po
|
||||
* ThirdPlugin/locale/it.po
|
||||
|
||||
Because I can extract everything with one click.
|
||||
|
||||
.. _GitHub: https://github.com/
|
||||
.. _Limnoria repository: https://github.com/ProgVal/Limnoria
|
||||
@ -14,6 +14,7 @@ Contents:
|
||||
use/index.rst
|
||||
plugins/index.rst
|
||||
core/index.rst
|
||||
contribute/index.rst
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
@ -59,8 +59,8 @@ ping takes no arguments
|
||||
I think it is clear enough.
|
||||
|
||||
join <channel> [<key>]
|
||||
This is the help for :ref:`command-channel-join`.
|
||||
|
||||
This is the help for :ref:`command-admin-join`.
|
||||
|
||||
It requires a channel name, and the channel key is optional.
|
||||
|
||||
This two commands are ok::
|
||||
@ -69,7 +69,7 @@ join <channel> [<key>]
|
||||
join #limnoria MySecretKey
|
||||
|
||||
utilities last <text> [<text> ...]
|
||||
This is the help for :ref:`command-utitilies-last`.
|
||||
This is the help for :ref:`command-utilities-last`.
|
||||
By the way, there is another ``last`` command in the `Misc` plugin, which
|
||||
doesn't do the same thing, that's why you need to give the plugin name.
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ Dependencies
|
||||
Here's the list of recommended software to run Supybot:
|
||||
|
||||
* Supybot is written in Python, and requires `Python`_
|
||||
2.4 or greater (but not Python 3).
|
||||
2.4 or greater (but not Python 3).
|
||||
* `Twisted`_ framework 1.2.0 or greater (optional, you probably don't need it).
|
||||
|
||||
.. _Python: http://www.python.org/
|
||||
|
||||
@ -7,7 +7,7 @@ The Admin plugin
|
||||
Capabilities
|
||||
------------
|
||||
|
||||
.. _command-channel-capability-add:
|
||||
.. _command-admin-capability-add:
|
||||
|
||||
capability add <name|hostmask> <capability>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
@ -15,7 +15,7 @@ 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:
|
||||
.. _command-admin-capability-remove:
|
||||
|
||||
capability remove <name|hostmask> <capability>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
@ -26,7 +26,7 @@ Takes from the user specified by *<name>* (or the user to whom
|
||||
Channels
|
||||
--------
|
||||
|
||||
.. _command-channel-channels:
|
||||
.. _command-admin-channels:
|
||||
|
||||
channels
|
||||
^^^^^^^^
|
||||
@ -34,7 +34,7 @@ channels
|
||||
Returns the channels the bot is on. Must be given in private, in order
|
||||
to protect the secrecy of secret channels.
|
||||
|
||||
.. _command-channel-join:
|
||||
.. _command-admin-join:
|
||||
|
||||
join <channel> [<key>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
@ -42,7 +42,7 @@ 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:
|
||||
.. _command-admin-part:
|
||||
|
||||
part [<channel>] [<reason>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
@ -55,14 +55,14 @@ message.
|
||||
Ignores
|
||||
-------
|
||||
|
||||
.. _command-channel-ignore-list:
|
||||
.. _command-admin-ignore-list:
|
||||
|
||||
ignore list
|
||||
^^^^^^^^^^^
|
||||
|
||||
Lists the hostmasks that the bot is ignoring.
|
||||
|
||||
.. _command-channel-ignore-remove:
|
||||
.. _command-admin-ignore-remove:
|
||||
|
||||
ignore remove <hostmask|nick>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
@ -70,7 +70,7 @@ ignore remove <hostmask|nick>
|
||||
This will remove the persistent ignore on *<hostmask>* or the
|
||||
hostmask currently associated with *<nick>*.
|
||||
|
||||
.. _command-channel-ignore-add:
|
||||
.. _command-admin-ignore-add:
|
||||
|
||||
ignore add <hostmask|nick> [<expires>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
@ -83,7 +83,7 @@ it isn't given, the ignore will never automatically expire.
|
||||
Miscellaneous
|
||||
-------------
|
||||
|
||||
.. _command-channel-nick:
|
||||
.. _command-admin-nick:
|
||||
|
||||
nick [<nick>]
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
@ -7,14 +7,14 @@ The Alias plugin
|
||||
Protecting
|
||||
----------
|
||||
|
||||
.. _command-channel-lock:
|
||||
.. _command-alias-lock:
|
||||
|
||||
lock <alias>
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Locks an alias so that no one else can change it.
|
||||
|
||||
.. _command-channel-unlock:
|
||||
.. _command-alias-unlock:
|
||||
|
||||
unlock <alias>
|
||||
^^^^^^^^^^^^^^
|
||||
@ -24,7 +24,7 @@ Unlocks an alias so that people can define new aliases over it.
|
||||
Adding and removing
|
||||
-------------------
|
||||
|
||||
.. _command-channel-add:
|
||||
.. _command-alias-add:
|
||||
|
||||
add <name> <alias>
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
@ -36,7 +36,7 @@ arguments. $1, $2, etc. can be used for required arguments. @1, @2,
|
||||
etc. can be used for optional arguments. $* simply means "all
|
||||
remaining arguments," and cannot be combined with optional arguments.
|
||||
|
||||
.. _command-channel-remove:
|
||||
.. _command-alias-remove:
|
||||
|
||||
remove <name>
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
7
use/plugins/attackprotector.rst
Normal file
7
use/plugins/attackprotector.rst
Normal file
@ -0,0 +1,7 @@
|
||||
|
||||
.. _plugin-attackprotector:
|
||||
|
||||
The AttackProtector plugin
|
||||
==========================
|
||||
|
||||
.. include:: unofficial.inc
|
||||
@ -260,10 +260,6 @@ 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:
|
||||
|
||||
42
use/plugins/github.rst
Normal file
42
use/plugins/github.rst
Normal file
@ -0,0 +1,42 @@
|
||||
|
||||
.. _plugin-github:
|
||||
|
||||
The GitHub plugin
|
||||
=================
|
||||
|
||||
.. _command-github-repo-info:
|
||||
|
||||
github repo info <owner> <repository> [--enable <feature> <feature> ...] [--disable <feature> <feature>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Displays informations about *<owner>*'s *<repository>*.
|
||||
Enable or disable features (ie. displayed data) according to the
|
||||
request).
|
||||
|
||||
.. _command-github-repo-search:
|
||||
|
||||
github repo search <searched string> [--page <id>] [--language <language>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Searches the string in the repository names database. You can
|
||||
specify the page *<id>* of the results, and restrict the search
|
||||
to a particular programming *<language>*.
|
||||
|
||||
.. _command-github-announce-remove:
|
||||
|
||||
github announce remove [<channel>] <owner> <name>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Don't announce the commits of the GitHub repository called
|
||||
*<owner>*/*<name>* in the *<channel>* anymore.
|
||||
*<channel>* defaults to the current channel.
|
||||
|
||||
.. _command-github-announce-add:
|
||||
|
||||
github announce add [<channel>] <owner> <name>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Announce the commits of the GitHub repository called
|
||||
*<owner>*/*<name>* in the *<channel>*.
|
||||
*<channel>* defaults to the current channel.
|
||||
|
||||
6
use/plugins/gui.rst
Normal file
6
use/plugins/gui.rst
Normal file
@ -0,0 +1,6 @@
|
||||
|
||||
.. _plugin-gui:
|
||||
|
||||
The GUI plugin
|
||||
==============
|
||||
|
||||
@ -26,6 +26,7 @@ Channel-specific plugins
|
||||
:maxdepth: 3
|
||||
|
||||
automode.rst
|
||||
attackprotector.rst
|
||||
badwords.rst
|
||||
channellogger.rst
|
||||
channelstats.rst
|
||||
@ -34,6 +35,7 @@ Channel-specific plugins
|
||||
karma.rst
|
||||
lart.rst
|
||||
limiter.rst
|
||||
linkrelay.rst
|
||||
moobotfactoids.rst
|
||||
protector.rst
|
||||
topic.rst
|
||||
@ -69,10 +71,13 @@ Internal tools
|
||||
dunno.rst
|
||||
format.rst
|
||||
messageparser.rst
|
||||
packages.rst
|
||||
plugindownloader.rst
|
||||
reply.rst
|
||||
scheduler.rst
|
||||
success.rst
|
||||
sudo.rst
|
||||
trigger.rst
|
||||
utilities.rst
|
||||
|
||||
Fun
|
||||
@ -83,10 +88,13 @@ Fun
|
||||
|
||||
filter.rst
|
||||
games.rst
|
||||
megahal.rst
|
||||
nickometer.rst
|
||||
praise.rst
|
||||
quote.rst
|
||||
quotegrabs.rst
|
||||
timebomb.rst
|
||||
trivia.rst
|
||||
|
||||
Other plugins
|
||||
=============
|
||||
@ -96,11 +104,14 @@ Other plugins
|
||||
|
||||
dict.rst
|
||||
google.rst
|
||||
github.rst
|
||||
gui.rst
|
||||
internet.rst
|
||||
math.rst
|
||||
status.rst
|
||||
time.rst
|
||||
todo.rst
|
||||
twitter.rst
|
||||
unix.rst
|
||||
url.rst
|
||||
web.rst
|
||||
|
||||
71
use/plugins/linkrelay.rst
Normal file
71
use/plugins/linkrelay.rst
Normal file
@ -0,0 +1,71 @@
|
||||
|
||||
.. _plugin-linkrelay:
|
||||
|
||||
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>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Undo a substitution.
|
||||
|
||||
.. _command-linkrelay-nicks:
|
||||
|
||||
linkrelay nicks [<channel>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Returns the nicks of the people in the linked channels.
|
||||
*<channel>* is only necessary if the message
|
||||
isn't sent on the channel itself.
|
||||
|
||||
.. _command-linkrelay-list:
|
||||
|
||||
linkrelay list
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Returns all the defined relay links
|
||||
|
||||
.. _command-linkrelay-remove:
|
||||
|
||||
linkrelay remove [--from <channel>@<network>] [--to <channel>@<network>] [--regexp <regexp>] [--reciprocal]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Remove a relay from the list. You must give at least *--from* or *--to;* if
|
||||
one of them is not given, it defaults to the current channel@network.
|
||||
Only messages matching *<regexp>* will be relayed; if *<regexp>* is not
|
||||
given, everything is relayed.
|
||||
If *--reciprocal* is given, another relay will be removed automatically,
|
||||
in the opposite direction.
|
||||
|
||||
.. _command-linkrelay-add:
|
||||
|
||||
linkrelay add [--from <channel>@<network>] [--to <channel>@<network>] [--regexp <regexp>] [--reciprocal]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Adds a relay to the list. You must give at least *--from* or *--to;* if
|
||||
one of them is not given, it defaults to the current channel@network.
|
||||
Only messages matching *<regexp>* will be relayed; if *<regexp>* is not
|
||||
given, everything is relayed.
|
||||
If *--reciprocal* is given, another relay will be added automatically,
|
||||
in the opposite direction.
|
||||
|
||||
.. _command-linkrelay-substitute:
|
||||
|
||||
linkrelay substitute <regexp> <replacement>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Replaces all nicks that matches the *<regexp>* by the *<replacement>*
|
||||
string.
|
||||
|
||||
29
use/plugins/megahal.rst
Normal file
29
use/plugins/megahal.rst
Normal file
@ -0,0 +1,29 @@
|
||||
|
||||
.. _plugin-megahal:
|
||||
|
||||
The MegaHAL plugin
|
||||
==================
|
||||
|
||||
Provides an interface to the MegaHAL chatterbot.
|
||||
|
||||
.. WARNING::
|
||||
|
||||
This plugin is **highly** deprecated and unstable.
|
||||
|
||||
It may cause your bot to randomly uppercase some letters, and you'll
|
||||
have to restart it to make it stop (temporaly).
|
||||
This is particulary annoying, and you won't be able to identify,
|
||||
because it uppercases letters in your password.
|
||||
More over, only this bug has been noticed, but it may cause security
|
||||
issues with your bot.
|
||||
|
||||
You shouldn't use it at all.
|
||||
|
||||
.. include:: unofficial.inc
|
||||
|
||||
.. _command-megahal-clean:
|
||||
|
||||
clean
|
||||
^^^^^
|
||||
|
||||
Saves MegaHAL brain to disk.
|
||||
50
use/plugins/packages.rst
Normal file
50
use/plugins/packages.rst
Normal file
@ -0,0 +1,50 @@
|
||||
|
||||
.. _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/
|
||||
|
||||
40
use/plugins/sudo.rst
Normal file
40
use/plugins/sudo.rst
Normal file
@ -0,0 +1,40 @@
|
||||
|
||||
.. _plugin-sudo:
|
||||
|
||||
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.
|
||||
|
||||
.. _command-sudo-add:
|
||||
|
||||
sudo add [<priority>] <name> {allow,deny} [<hostmask>] <regexp>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Sets a new Sudo rule, called *<name>* with the given *<priority>*
|
||||
(greatest numbers have precedence),
|
||||
allowing or denying to run commands matching the pattern *<regexp>*,
|
||||
from users to run commands as wearing the *<hostmask>*.
|
||||
The *<priority>* must be a relative integer.
|
||||
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.
|
||||
|
||||
45
use/plugins/timebomb.rst
Normal file
45
use/plugins/timebomb.rst
Normal file
@ -0,0 +1,45 @@
|
||||
|
||||
.. _plugin-timebomb:
|
||||
|
||||
The Timebomb plugin
|
||||
===================
|
||||
|
||||
The timebomb game.
|
||||
|
||||
.. include:: unofficial.inc
|
||||
|
||||
.. _command-timebomb-cutwire:
|
||||
|
||||
timebomb cutwire <colored wire>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Will cut the given wire if you've been timebombed.
|
||||
|
||||
.. _command-timebomb-randombomb:
|
||||
|
||||
timebomb randombomb
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Bombs a random person in the channel
|
||||
|
||||
.. _command-timebomb-detonate:
|
||||
|
||||
timebomb detonate Takes no arguments
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Detonates the active bomb.
|
||||
|
||||
.. _command-timebomb-duck:
|
||||
|
||||
timebomb duck
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
DUCK!
|
||||
|
||||
.. _command-timebomb-timebomb:
|
||||
|
||||
timebomb timebomb <nick>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
For bombing people!
|
||||
|
||||
15
use/plugins/trigger.rst
Normal file
15
use/plugins/trigger.rst
Normal file
@ -0,0 +1,15 @@
|
||||
|
||||
.. _plugin-trigger:
|
||||
|
||||
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-conditional` may also be useful here.
|
||||
24
use/plugins/trivia.rst
Normal file
24
use/plugins/trivia.rst
Normal file
@ -0,0 +1,24 @@
|
||||
|
||||
.. _plugin-trivia:
|
||||
|
||||
The Trivia plugin
|
||||
=================
|
||||
|
||||
The trivia game.
|
||||
|
||||
.. include:: unofficial.inc
|
||||
|
||||
.. _command-trivia-strivia:
|
||||
|
||||
trivia strivia [<channel>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Stops a running game of trivia. *<channel>* is only necessary if the message isn't sent in the channel itself.
|
||||
|
||||
.. _command-trivia-trivia:
|
||||
|
||||
trivia trivia [<channel>] [<number of questions>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Starts a game of trivia. *<channel>* is only necessary if the message isn't sent in the channel itself.
|
||||
|
||||
46
use/plugins/twitter.rst
Normal file
46
use/plugins/twitter.rst
Normal file
@ -0,0 +1,46 @@
|
||||
|
||||
.. _plugin-twitter:
|
||||
|
||||
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>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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-timeline:
|
||||
|
||||
twitter timeline [<channel>|<user>] [--since <oldest>] [--max <newest>] [--count <number>] [--noretweet]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Replies with the timeline of the *<user>*.
|
||||
If *<user>* is not given, it defaults to the account associated with the
|
||||
*<channel>*.
|
||||
If *<channel>* is not given, it defaults to the current channel.
|
||||
If given, *--since* and *--max* take tweet IDs, used as boundaries.
|
||||
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-post:
|
||||
|
||||
twitter post [<channel>] <message>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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.
|
||||
|
||||
@ -56,7 +56,7 @@ based crypt rather than the standard DES based crypt.
|
||||
unix 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:
|
||||
|
||||
|
||||
6
use/plugins/unofficial.inc
Normal file
6
use/plugins/unofficial.inc
Normal file
@ -0,0 +1,6 @@
|
||||
|
||||
.. NOTE::
|
||||
This plugin is not provided with Limnoria. You need to download it yourself,
|
||||
either from a repository or with
|
||||
:ref:`PluginDownloader <plugin-plugindownloader>`.
|
||||
|
||||
15
use/plugins/wikipedia.rst
Normal file
15
use/plugins/wikipedia.rst
Normal file
@ -0,0 +1,15 @@
|
||||
|
||||
.. _plugin-wikipedia:
|
||||
|
||||
The Wikipedia plugin
|
||||
====================
|
||||
|
||||
.. include:: unofficial.inc
|
||||
|
||||
.. _command-wikipedia-wiki:
|
||||
|
||||
wikipedia wiki <search term>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Returns the first paragraph of a Wikipedia article
|
||||
|
||||
@ -8,9 +8,13 @@ Third-party repositories
|
||||
Repositories available with :ref:`PluginDownloader <plugin-plugindownloader>`
|
||||
=============================================================================
|
||||
|
||||
.. _repository-progval:
|
||||
|
||||
ProgVal's repository
|
||||
--------------------
|
||||
|
||||
https://github.com/ProgVal/Supybot-plugins
|
||||
|
||||
ProgVal's repository contains various plugins, mainly hacks, utilities,
|
||||
website access or updated plugins.
|
||||
|
||||
@ -20,7 +24,7 @@ website access or updated plugins.
|
||||
user interface to Supybot.
|
||||
* :ref:`LinkRelay <plugin-linkrelay>`: Enhanced version of quantumlemur's
|
||||
LinkRelay: a highly configurable relay between channels.
|
||||
* :ref:`Packages <plugin-package>`: An abandonned packaging system with
|
||||
* :ref:`Packages <plugin-packages>`: An abandonned packaging system with
|
||||
dependencies handling.
|
||||
* :ref:`GitHub <plugin-github>`: Access to the GitHub API. Support for
|
||||
Post-receive URLs.
|
||||
@ -35,6 +39,28 @@ website access or updated plugins.
|
||||
user access to a restricted command only if the commands matches a given
|
||||
regular expression.
|
||||
|
||||
.. _repository-quantumlemur:
|
||||
|
||||
quantumlemur's repository
|
||||
-------------------------
|
||||
|
||||
https://github.com/quantumlemur/Supybot-plugins
|
||||
|
||||
* :ref:`LinkRelay <plugin-linkrelay>`: Highly configurable relay between
|
||||
channels.
|
||||
* :ref:`Timebomb <plugin-timebomb>`: The timebomb game.
|
||||
* :ref:`Triva <plugin-trivia>`: A trivia game.
|
||||
* :ref:`Wikipedia <plugin-wikipedia>`: Retrieve Wikipedia pages.
|
||||
|
||||
.. _repository-stepnem:
|
||||
|
||||
stepnem's repository
|
||||
--------------------
|
||||
|
||||
https://github.com/stepnem/supybot-plugins
|
||||
|
||||
A bunch of old plugins.
|
||||
|
||||
.. NOTE::
|
||||
|
||||
This list is not exhaustive.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user