From 0cf36f7f8dc736f5eb4481fcdac792c3d68e0390 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Thu, 31 Jan 2013 19:33:47 +0100 Subject: [PATCH] Remove plugins docs. --- develop/index.rst | 1 + use/plugins/admin.rst | 109 --------- use/plugins/alias.rst | 70 ------ use/plugins/anonymous.rst | 76 ------ use/plugins/attackprotector.rst | 258 -------------------- use/plugins/automode.rst | 105 --------- use/plugins/badwords.rst | 118 ---------- use/plugins/brainfuck.rst | 47 ---- use/plugins/channel.rst | 390 ------------------------------- use/plugins/channellogger.rst | 130 ----------- use/plugins/channelstats.rst | 80 ------- use/plugins/coffee.rst | 34 --- use/plugins/conditional.rst | 167 ------------- use/plugins/config.rst | 98 -------- use/plugins/ctcp.rst | 45 ---- use/plugins/debian.rst | 91 -------- use/plugins/dict.rst | 76 ------ use/plugins/dunno.rst | 31 --- use/plugins/erepublik.rst | 104 --------- use/plugins/eureka.rst | 127 ---------- use/plugins/factoids.rst | 212 ----------------- use/plugins/filter.rst | 271 --------------------- use/plugins/format.rst | 154 ------------ use/plugins/games.rst | 68 ------ use/plugins/github.rst | 93 -------- use/plugins/goodfrench.rst | 44 ---- use/plugins/google.rst | 146 ------------ use/plugins/gui.rst | 42 ---- use/plugins/herald.rst | 150 ------------ use/plugins/index.rst | 135 ----------- use/plugins/internet.rst | 46 ---- use/plugins/karma.rst | 128 ---------- use/plugins/lart.rst | 43 ---- use/plugins/later.rst | 85 ------- use/plugins/limiter.rst | 49 ---- use/plugins/linkrelay.rst | 229 ------------------ use/plugins/math.rst | 80 ------- use/plugins/messageparser.rst | 171 -------------- use/plugins/misc.rst | 170 -------------- use/plugins/moobotfactoids.rst | 138 ----------- use/plugins/network.rst | 103 -------- use/plugins/news.rst | 75 ------ use/plugins/nickcapture.rst | 40 ---- use/plugins/nickometer.rst | 33 --- use/plugins/note.rst | 121 ---------- use/plugins/owner.rst | 178 -------------- use/plugins/plugin.rst | 78 ------- use/plugins/plugindownloader.rst | 41 ---- use/plugins/praise.rst | 43 ---- use/plugins/protector.rst | 41 ---- use/plugins/quote.rst | 33 --- use/plugins/quotegrabs.rst | 125 ---------- use/plugins/relay.rst | 136 ----------- use/plugins/reply.rst | 64 ----- use/plugins/rss.rst | 196 ---------------- use/plugins/scheduler.rst | 60 ----- use/plugins/seeks.rst | 70 ------ use/plugins/seen.rst | 72 ------ use/plugins/services.rst | 194 --------------- use/plugins/shrinkurl.rst | 118 ---------- use/plugins/status.rst | 117 ---------- use/plugins/string.rst | 151 ------------ use/plugins/success.rst | 31 --- use/plugins/sudo.rst | 63 ----- use/plugins/supyml.rst | 43 ---- use/plugins/supysandbox.rst | 33 --- use/plugins/time.rst | 96 -------- use/plugins/timebomb.rst | 48 ---- use/plugins/todo.rst | 85 ------- use/plugins/topic.rst | 274 ---------------------- use/plugins/trigger.rst | 78 ------- use/plugins/trivia.rst | 27 --- use/plugins/twitter.rst | 185 --------------- use/plugins/unix.rst | 212 ----------------- use/plugins/unofficial.inc | 8 - use/plugins/url.rst | 55 ----- use/plugins/user.rst | 184 --------------- use/plugins/utilities.rst | 94 -------- use/plugins/web.rst | 129 ---------- use/plugins/webstats.rst | 51 ---- use/plugins/wikipedia.rst | 40 ---- use/plugins/wikitrans.rst | 35 --- 82 files changed, 1 insertion(+), 8470 deletions(-) delete mode 100644 use/plugins/admin.rst delete mode 100644 use/plugins/alias.rst delete mode 100644 use/plugins/anonymous.rst delete mode 100644 use/plugins/attackprotector.rst delete mode 100644 use/plugins/automode.rst delete mode 100644 use/plugins/badwords.rst delete mode 100644 use/plugins/brainfuck.rst delete mode 100644 use/plugins/channel.rst delete mode 100644 use/plugins/channellogger.rst delete mode 100644 use/plugins/channelstats.rst delete mode 100644 use/plugins/coffee.rst delete mode 100644 use/plugins/conditional.rst delete mode 100644 use/plugins/config.rst delete mode 100644 use/plugins/ctcp.rst delete mode 100644 use/plugins/debian.rst delete mode 100644 use/plugins/dict.rst delete mode 100644 use/plugins/dunno.rst delete mode 100644 use/plugins/erepublik.rst delete mode 100644 use/plugins/eureka.rst delete mode 100644 use/plugins/factoids.rst delete mode 100644 use/plugins/filter.rst delete mode 100644 use/plugins/format.rst delete mode 100644 use/plugins/games.rst delete mode 100644 use/plugins/github.rst delete mode 100644 use/plugins/goodfrench.rst delete mode 100644 use/plugins/google.rst delete mode 100644 use/plugins/gui.rst delete mode 100644 use/plugins/herald.rst delete mode 100644 use/plugins/index.rst delete mode 100644 use/plugins/internet.rst delete mode 100644 use/plugins/karma.rst delete mode 100644 use/plugins/lart.rst delete mode 100644 use/plugins/later.rst delete mode 100644 use/plugins/limiter.rst delete mode 100644 use/plugins/linkrelay.rst delete mode 100644 use/plugins/math.rst delete mode 100644 use/plugins/messageparser.rst delete mode 100644 use/plugins/misc.rst delete mode 100644 use/plugins/moobotfactoids.rst delete mode 100644 use/plugins/network.rst delete mode 100644 use/plugins/news.rst delete mode 100644 use/plugins/nickcapture.rst delete mode 100644 use/plugins/nickometer.rst delete mode 100644 use/plugins/note.rst delete mode 100644 use/plugins/owner.rst delete mode 100644 use/plugins/plugin.rst delete mode 100644 use/plugins/plugindownloader.rst delete mode 100644 use/plugins/praise.rst delete mode 100644 use/plugins/protector.rst delete mode 100644 use/plugins/quote.rst delete mode 100644 use/plugins/quotegrabs.rst delete mode 100644 use/plugins/relay.rst delete mode 100644 use/plugins/reply.rst delete mode 100644 use/plugins/rss.rst delete mode 100644 use/plugins/scheduler.rst delete mode 100644 use/plugins/seeks.rst delete mode 100644 use/plugins/seen.rst delete mode 100644 use/plugins/services.rst delete mode 100644 use/plugins/shrinkurl.rst delete mode 100644 use/plugins/status.rst delete mode 100644 use/plugins/string.rst delete mode 100644 use/plugins/success.rst delete mode 100644 use/plugins/sudo.rst delete mode 100644 use/plugins/supyml.rst delete mode 100644 use/plugins/supysandbox.rst delete mode 100644 use/plugins/time.rst delete mode 100644 use/plugins/timebomb.rst delete mode 100644 use/plugins/todo.rst delete mode 100644 use/plugins/topic.rst delete mode 100644 use/plugins/trigger.rst delete mode 100644 use/plugins/trivia.rst delete mode 100644 use/plugins/twitter.rst delete mode 100644 use/plugins/unix.rst delete mode 100644 use/plugins/unofficial.inc delete mode 100644 use/plugins/url.rst delete mode 100644 use/plugins/user.rst delete mode 100644 use/plugins/utilities.rst delete mode 100644 use/plugins/web.rst delete mode 100644 use/plugins/webstats.rst delete mode 100644 use/plugins/wikipedia.rst delete mode 100644 use/plugins/wikitrans.rst diff --git a/develop/index.rst b/develop/index.rst index 5849e6c..52beffd 100644 --- a/develop/index.rst +++ b/develop/index.rst @@ -22,4 +22,5 @@ Other docs: .. toctree:: :maxdepth: 0 + callbacks.rst httpserver.rst diff --git a/use/plugins/admin.rst b/use/plugins/admin.rst deleted file mode 100644 index d492d85..0000000 --- a/use/plugins/admin.rst +++ /dev/null @@ -1,109 +0,0 @@ - -.. _plugin-admin: - -The Admin plugin -================ - -Capabilities ------------- - -.. _command-admin-capability-add: - -capability add -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Gives the user specified by ** (or the user to whom ** -currently maps) the specified capability ** - -.. _command-admin-capability-remove: - -capability remove -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Takes from the user specified by ** (or the user to whom -** currently maps) the specified capability ** - -Channels --------- - -.. _command-admin-channels: - -channels -^^^^^^^^ - -Returns the channels the bot is on. Must be given in private, in order -to protect the secrecy of secret channels. - -.. _command-admin-join: - -join [] -^^^^^^^^^^^^^^^^^^^^^^ - -Tell the bot to join the given channel. If ** is given, it is used -when attempting to join the channel. - -.. _command-admin-part: - -part [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Tells the bot to part the list of channels you give it. ** is -only necessary if you want the bot to part a channel other than the -current channel. If ** is specified, use it as the part -message. - -Ignores -------- - -.. _command-admin-ignore-list: - -ignore list -^^^^^^^^^^^ - -Lists the hostmasks that the bot is ignoring. - -.. _command-admin-ignore-remove: - -ignore remove -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This will remove the persistent ignore on ** or the -hostmask currently associated with **. - -.. _command-admin-ignore-add: - -ignore add [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This will set a persistent ignore on ** or the hostmask -currently associated with **. ** is an optional argument -specifying when (in "seconds from now") the ignore will expire; if -it isn't given, the ignore will never automatically expire. - -Miscellaneous -------------- - -.. _command-admin-nick: - -nick [] -^^^^^^^^^^^^^ - -Changes the bot's nick to **. If no nick is given, returns the -bot's current nick. - - - -.. _plugin-admin-config: - -Configuration -------------- - -.. _supybot.plugins.Admin.public: - -supybot.plugins.Admin.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/alias.rst b/use/plugins/alias.rst deleted file mode 100644 index a08edc0..0000000 --- a/use/plugins/alias.rst +++ /dev/null @@ -1,70 +0,0 @@ - -.. _plugin-alias: - -The Alias plugin -================ - -Protecting ----------- - -.. _command-alias-lock: - -lock -^^^^^^^^^^^^ - -Locks an alias so that no one else can change it. - -.. _command-alias-unlock: - -unlock -^^^^^^^^^^^^^^ - -Unlocks an alias so that people can define new aliases over it. - -Adding and removing -------------------- - -.. _command-alias-add: - -add -^^^^^^^^^^^^^^^^^^ - -Defines an alias ** that executes **. The ** -should be in the standard "command argument [nestedcommand argument]" -arguments to the alias; they'll be filled with the first, second, etc. -arguments. $1, $2, etc. can be used for required arguments. @1, @2, -etc. can be used for optional arguments. $* simply means "all -remaining arguments," and cannot be combined with optional arguments. - -.. _command-alias-remove: - -remove -^^^^^^^^^^^^^ - -Removes the given alias, if unlocked. - - - -.. _plugin-alias-config: - -Configuration -------------- - -.. _supybot.plugins.Alias.aliases: - -supybot.plugins.Alias.aliases -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.Alias.public: - -supybot.plugins.Alias.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/anonymous.rst b/use/plugins/anonymous.rst deleted file mode 100644 index ed8e0b9..0000000 --- a/use/plugins/anonymous.rst +++ /dev/null @@ -1,76 +0,0 @@ - -.. _plugin-anonymous: - -The Anonymous plugin -==================== - -Commands --------- - -.. _command-channel-do: - -do -^^^^^^^^^^^^^^^^^^^^^ - -Performs ** in **. - -.. _command-channel-say: - -say -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sends ** to **. Can only send to ** if -:ref:`supybot.plugins.Anonymous.allowPrivateTarget` is True. - - - -.. _plugin-anonymous-config: - -Configuration -------------- - -.. _supybot.plugins.Anonymous.requirePresenceInChannel: - -supybot.plugins.Anonymous.requirePresenceInChannel -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot should require people trying to use this plugin to be in the channel they wish to anonymously send to. - -.. _supybot.plugins.Anonymous.allowPrivateTarget: - -supybot.plugins.Anonymous.allowPrivateTarget -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will require targets of the "say" command to be public (i.e., channels). If this is True, the bot will allow people to use the "say" command to send private messages to other users. - -.. _supybot.plugins.Anonymous.public: - -supybot.plugins.Anonymous.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.Anonymous.requireCapability: - -supybot.plugins.Anonymous.requireCapability -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Determines what capability (if any) the bot should require people trying to use this plugin to have. - -.. _supybot.plugins.Anonymous.requireRegistration: - -supybot.plugins.Anonymous.requireRegistration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot should require people trying to use this plugin to be registered. - diff --git a/use/plugins/attackprotector.rst b/use/plugins/attackprotector.rst deleted file mode 100644 index 69f17c1..0000000 --- a/use/plugins/attackprotector.rst +++ /dev/null @@ -1,258 +0,0 @@ - -.. _plugin-attackprotector: - -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. - diff --git a/use/plugins/automode.rst b/use/plugins/automode.rst deleted file mode 100644 index 1ab2d5b..0000000 --- a/use/plugins/automode.rst +++ /dev/null @@ -1,105 +0,0 @@ - -.. _plugin-automode: - -The AutoMode plugin -=================== - -This plugins enables your bot to automatically voice, halfop, and op people on -your channel, according to their capabilities. - -Owners ------- - -Owners are always opped unless you set :ref:`supybot.plugins.AutoMode.owner` -to False. -With stock Supybot and Gribble, setting this to False will cause no automode -at all for owners. In Limnoria, settings this to False will make automode -work as for normal users (only channel capabilities count). - - -.. _plugin-automode-config: - -Configuration -------------- - -.. _supybot.plugins.AutoMode.enable: - -supybot.plugins.AutoMode.enable -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is enabled. - -.. _supybot.plugins.AutoMode.fallthrough: - -supybot.plugins.AutoMode.fallthrough -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will "fall through" to halfop/voicing when auto-opping is turned off but auto-halfopping/voicing are turned on. - -.. _supybot.plugins.AutoMode.halfop: - -supybot.plugins.AutoMode.halfop -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will automatically halfop people with the ,halfop capability when they join the channel. - -.. _supybot.plugins.AutoMode.op: - -supybot.plugins.AutoMode.op -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will automatically op people with the ,op capability when they join the channel. - -.. _supybot.plugins.AutoMode.voice: - -supybot.plugins.AutoMode.voice -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will automatically voice people with the ,voice capability when they join the channel. - -.. _supybot.plugins.AutoMode.ban: - -supybot.plugins.AutoMode.ban -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will automatically ban people who join the channel and are on the banlist. - -.. _supybot.plugins.AutoMode.ban.period: - -supybot.plugins.AutoMode.ban.period -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 86400 - -Determines how many seconds the bot will automatically ban a person when banning. - -.. _supybot.plugins.AutoMode.owner: - -supybot.plugins.AutoMode.owner -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin will automode owners even if they don't have op/halfop/voice/whatever capability. - -.. _supybot.plugins.AutoMode.public: - -supybot.plugins.AutoMode.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/badwords.rst b/use/plugins/badwords.rst deleted file mode 100644 index 100aeb5..0000000 --- a/use/plugins/badwords.rst +++ /dev/null @@ -1,118 +0,0 @@ - -.. _plugin-badwords: - -The BadWords plugin -=================== - -Commands --------- - -.. _command-channel-list: - -list -^^^^ - -Returns the list of words being censored. - -.. _command-channel-remove: - -remove [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Removes *s* from the list of words being censored. - -.. _command-channel-add: - -add [ ...] -^^^^^^^^^^^^^^^^^^^^^^^ - -Adds all *s* to the list of words being censored. - - - -.. _plugin-badwords-config: - -Configuration -------------- - -.. _supybot.plugins.BadWords.kick: - -supybot.plugins.BadWords.kick -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will kick people with a warning when they use bad words. - -.. _supybot.plugins.BadWords.kick.message: - -supybot.plugins.BadWords.kick.message -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: You have been kicked for using a word prohibited in the presence of this bot. Please use more appropriate language in the future. - -Determines the kick message used by the bot when kicking users for saying bad words. - -.. _supybot.plugins.BadWords.nastyChars: - -supybot.plugins.BadWords.nastyChars -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: !@#& - -Determines what characters will replace bad words; a chunk of these characters matching the size of the replaced bad word will be used to replace the bad words you've configured. - -.. _supybot.plugins.BadWords.public: - -supybot.plugins.BadWords.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.BadWords.replaceMethod: - -supybot.plugins.BadWords.replaceMethod -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: nastyCharacters - -Determines the manner in which bad words will be replaced. 'nastyCharacters' (the default) will replace a bad word with the same number of 'nasty characters' (like those used in comic books; configurable by supybot.plugins.BadWords.nastyChars). 'simple' will replace a bad word with a simple strings (regardless of the length of the bad word); this string is configurable via supybot.plugins.BadWords.simpleReplacement. - -.. _supybot.plugins.BadWords.requireWordBoundaries: - -supybot.plugins.BadWords.requireWordBoundaries -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will require bad words to be independent words, or whether it will censor them within other words. For instance, if 'darn' is a bad word, then if this is true, 'darn' will be censored, but 'darnit' will not. You probably want this to be false. After changing this setting, the BadWords regexp needs to be regenerated by adding/removing a word to the list, or reloading the plugin. - -.. _supybot.plugins.BadWords.simpleReplacement: - -supybot.plugins.BadWords.simpleReplacement -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [CENSORED] - -Determines what word will replace bad words if the replacement method is 'simple'. - -.. _supybot.plugins.BadWords.stripFormatting: - -supybot.plugins.BadWords.stripFormatting -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will strip formatting characters from messages before it checks them for bad words. If this is False, it will be relatively trivial to circumvent this plugin's filtering. If it's True, however, it will interact poorly with other plugins that do coloring or bolding of text. - -.. _supybot.plugins.BadWords.words: - -supybot.plugins.BadWords.words -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Determines what words are considered to be 'bad' so the bot won't say them. - diff --git a/use/plugins/brainfuck.rst b/use/plugins/brainfuck.rst deleted file mode 100644 index 355f128..0000000 --- a/use/plugins/brainfuck.rst +++ /dev/null @@ -1,47 +0,0 @@ - -.. _plugin-brainfuck: - -The Brainfuck plugin -==================== - -.. include:: unofficial.inc - -Commands --------- - -.. _command-brainfuck-brainfuck: - -brainfuck brainfuck [--recover] [--input ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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 ** when it asks for input. - -.. _command-brainfuck-checksyntax: - -brainfuck checksyntax -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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. - diff --git a/use/plugins/channel.rst b/use/plugins/channel.rst deleted file mode 100644 index 883bf6d..0000000 --- a/use/plugins/channel.rst +++ /dev/null @@ -1,390 +0,0 @@ - -.. _plugin-channel: - -The Channel plugin -================== - -Lobotomy --------- - -.. _command-channel-lobotomy-list: - -lobotomy list -^^^^^^^^^^^^^ - -Returns the channels in which this bot is lobotomized. - -.. _command-channel-lobotomy-remove: - -lobotomy remove [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will unlobotomize the -bot, making it respond to requests made in the channel again. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-channel-lobotomy-add: - -lobotomy add [] -^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will "lobotomize" the -bot, making it silent and unanswering to all requests made in the -channel. ** is only necessary if the message isn't sent in -the channel itself. - -(Un)setting modes ------------------ - -.. _command-channel-unmoderate: - -unmoderate [] -^^^^^^^^^^^^^^^^^^^^^^ - -Sets -m on **, making it so everyone can -send messages to the channel. ** is only necessary if the -message isn't sent in the channel itself. - -.. _command-channel-devoice: - -devoice [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will remove voice from all -the nicks given. If no nicks are given, removes voice from the person -sending the message. - -.. _command-channel-deop: - -deop [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will remove operator -privileges from all the nicks given. If no nicks are given, removes -operator privileges from the person sending the message. - -.. _command-channel-limit: - -limit [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sets the channel limit to **. If ** is 0, or isn't given, -removes the channel limit. ** is only necessary if the message -isn't sent in the channel itself. - -.. _command-channel-moderate: - -moderate [] -^^^^^^^^^^^^^^^^^^^^ - -Sets +m on **, making it so only ops and voiced users can -send messages to the channel. ** is only necessary if the -message isn't sent in the channel itself. - -.. _command-channel-unban: - -unban [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Unbans ** on **. If ** is not given, unbans -any hostmask currently banned on ** that matches your current -hostmask. Especially useful for unbanning yourself when you get -unexpectedly (or accidentally) banned from the channel. ** is -only necessary if the message isn't sent in the channel itself. - -.. _command-channel-dehalfop: - -dehalfop [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will remove half-operator -privileges from all the nicks given. If no nicks are given, removes -half-operator privileges from the person sending the message. - -.. _command-channel-key: - -key [] [] -^^^^^^^^^^^^^^^^^^^^^^^ - -Sets the keyword in ** to **. If ** is not given, removes -the keyword requirement to join **. ** is only necessary -if the message isn't sent in the channel itself. - -.. _command-channel-halfop: - -halfop [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,halfop capability, this will give all the -**s you provide halfops. If you don't provide any **s, this -will give you halfops. ** is only necessary if the message isn't -sent in the channel itself. - -.. _command-channel-mode: - -mode [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sets the mode in ** to **, sending the arguments given. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-channel-ban-list: - -ban list [] -^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will show you the -current persistent bans on #channel. - -.. _command-channel-ban-remove: - -ban remove [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will remove the -persistent ban on **. ** is only necessary if the -message isn't sent in the channel itself. - -.. _command-channel-ban-add: - -ban add [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will effect a -persistent ban from interacting with the bot on the given -** (or the current hostmask associated with **. Other -plugins may enforce this ban by actually banning users with -matching hostmasks when they join. ** is an optional -argument specifying when (in "seconds from now") the ban should -expire; if none is given, the ban will never automatically expire. -** is only necessary if the message isn't sent in the -channel itself. - -.. _command-channel-voice: - -voice [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,voice capability, this will voice all the -**s you provide. If you don't provide any **s, this will -voice you. ** is only necessary if the message isn't sent in the -channel itself. - -.. _command-channel-op: - -op [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will give all the **s -you provide ops. If you don't provide any **s, this will op you. -** is only necessary if the message isn't sent in the channel -itself. - -Inviting and kicking users --------------------------- - -.. _command-channel-kick: - -kick [] [, , ...] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Kicks **(s) from ** for **. If ** isn't given, -uses the nick of the person making the command as the reason. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-channel-invite: - -invite [] -^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will invite ** -to join **. ** is only necessary if the message isn't -sent in the channel itself. - -.. _command-channel-kban: - -kban [] [--{exact,nick,user,host}] [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will kickban ** for -as many seconds as you specify, or else (if you specify 0 seconds or -don't specify a number of seconds) it will ban the person indefinitely. -*--exact* bans only the exact hostmask; *--nick* bans just the nick; -*--user* bans just the user, and *--host* bans just the host. You can -combine these options as you choose. ** is a reason to give for -the kick. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-channel-cycle: - -cycle [] -^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will cause the bot to -"cycle", or PART and then JOIN the channel. ** is only necessary -if the message isn't sent in the channel itself. - -Utitilies ---------- - -.. _command-channel-nicks: - -nicks [] [--count] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the nicks in **. ** is only necessary if the -message isn't sent in the channel itself. Returns only the number of -nicks if *--count* option is provided. - -.. _command-channel-alert: - -alert [] -^^^^^^^^^^^^^^^^^^^^^^^^ - -Sends ** to all the users in ** who have the **,op -capability. - -.. _command-channel-disable: - -disable [] [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will disable the ** -in **. If ** is provided, ** will be disabled only -for that plugin. If only ** is provided, all commands in the -given plugin will be disabled. ** is only necessary if the -message isn't sent in the channel itself. - -Ignores -------- - -.. _command-channel-ignore-list: - -ignore list [] -^^^^^^^^^^^^^^^^^^^^^^^ - -Lists the hostmasks that the bot is ignoring on the given channel. -** is only necessary if the message isn't sent in the -channel itself. - -.. _command-channel-ignore-remove: - -ignore remove [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will remove the -persistent ignore on ** in the channel. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-channel-ignore-add: - -ignore add [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will set a persistent -ignore on ** or the hostmask currently -associated with **. ** is an optional argument -specifying when (in "seconds from now") the ignore will expire; if -it isn't given, the ignore will never automatically expire. -** is only necessary if the message isn't sent in the -channel itself. - -Capabilities ------------- - -.. _command-channel-capability-set: - -capability set [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will add the channel -capability ** for all users in the channel. ** is -only necessary if the message isn't sent in the channel itself. - -.. _command-channel-capability-setdefault: - -capability setdefault [] {True|False} -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will set the default -response to non-power-related (that is, not {op, halfop, voice} -capabilities to be the value you give. ** is only necessary -if the message isn't sent in the channel itself. - -.. _command-channel-capability-list: - -capability list [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the capabilities present on the **. ** is -only necessary if the message isn't sent in the channel itself. - -.. _command-channel-capability-remove: - -capability remove [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will take from the -user currently identified as ** (or the user to whom ** -maps) the capability ** in the channel. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-channel-capability-add: - -capability add [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will give the user -** (or the user to whom ** maps) -the capability ** in the channel. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-channel-capability-unset: - -capability unset [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will unset the channel -capability ** so each user's specific capability or the -channel default capability will take precedence. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-channel-enable: - -enable [] [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have the #channel,op capability, this will enable the ** -in ** if it has been disabled. If ** is provided, -** will be enabled only for that plugin. If only ** is -provided, all commands in the given plugin will be enabled. ** -is only necessary if the message isn't sent in the channel itself. - - -.. _plugin-channel-config: - -Configuration -------------- - -.. _supybot.plugins.Channel.alwaysRejoin: - -supybot.plugins.Channel.alwaysRejoin -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will always try to rejoin a channel whenever it's kicked from the channel. - -.. _supybot.plugins.Channel.public: - -supybot.plugins.Channel.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/channellogger.rst b/use/plugins/channellogger.rst deleted file mode 100644 index 54c1031..0000000 --- a/use/plugins/channellogger.rst +++ /dev/null @@ -1,130 +0,0 @@ - -.. _plugin-channellogger: - -The ChannelLogger plugin -======================== - - - -.. _plugin-channellogger-config: - -Configuration -------------- - -.. _supybot.plugins.ChannelLogger.enable: - -supybot.plugins.ChannelLogger.enable -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether logging is enabled. - -.. _supybot.plugins.ChannelLogger.filenameTimestamp: - -supybot.plugins.ChannelLogger.filenameTimestamp -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: %Y-%m-%d - -Determines how to represent the timestamp used for the filename in rotated logs. When this timestamp changes, the old logfiles will be closed and a new one started. The format characters for the timestamp are in the time.strftime docs at python.org. In order for your logs to be rotated, you'll also have to enable supybot.plugins.ChannelLogger.rotateLogs. - -.. _supybot.plugins.ChannelLogger.noLogPrefix: - -supybot.plugins.ChannelLogger.noLogPrefix -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [nolog] - -Determines what string a message should be prefixed with in order not to be logged. If you don't want any such prefix, just set it to the empty string. - -.. _supybot.plugins.ChannelLogger.rotateLogs: - -supybot.plugins.ChannelLogger.rotateLogs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will automatically rotate the logs for this channel. The bot will rotate logs when the timestamp for the log changes. The timestamp is set according to the 'filenameTimestamp' configuration variable. - -.. _supybot.plugins.ChannelLogger.stripFormatting: - -supybot.plugins.ChannelLogger.stripFormatting -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether formatting characters (such as bolding, color, etc.) are removed when writing the logs to disk. - -.. _supybot.plugins.ChannelLogger.timestamp: - -supybot.plugins.ChannelLogger.timestamp -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the logs for this channel are timestamped with the timestamp in supybot.log.timestampFormat. - -.. _supybot.plugins.ChannelLogger.directories: - -supybot.plugins.ChannelLogger.directories -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will partition its channel logs into separate directories based on different criteria. - -.. _supybot.plugins.ChannelLogger.directories.timestamp: - -supybot.plugins.ChannelLogger.directories.timestamp -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will use a timestamp (determined by supybot.plugins.ChannelLogger.directories.timestamp.format) if using directories. - -.. _supybot.plugins.ChannelLogger.directories.timestamp.format: - -supybot.plugins.ChannelLogger.directories.timestamp.format -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: %B - -Determines what timestamp format will be used in the directory structure for channel logs if supybot.plugins.ChannelLogger.directories.timestamp is True. - -.. _supybot.plugins.ChannelLogger.directories.channel: - -supybot.plugins.ChannelLogger.directories.channel -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will use a channel directory if using directories. - -.. _supybot.plugins.ChannelLogger.directories.network: - -supybot.plugins.ChannelLogger.directories.network -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will use a network directory if using directories. - -.. _supybot.plugins.ChannelLogger.flushImmediately: - -supybot.plugins.ChannelLogger.flushImmediately -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether channel logfiles will be flushed anytime they're written to, rather than being buffered by the operating system. - -.. _supybot.plugins.ChannelLogger.public: - -supybot.plugins.ChannelLogger.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/channelstats.rst b/use/plugins/channelstats.rst deleted file mode 100644 index c261066..0000000 --- a/use/plugins/channelstats.rst +++ /dev/null @@ -1,80 +0,0 @@ - -.. _plugin-channelstats: - -The ChannelStats plugin -======================= - -Commands --------- - -.. _command-channelstats-stats: - -channelstats stats [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the statistics for ** on **. ** is only -necessary if the message isn't sent on the channel itself. If ** -isn't given, it defaults to the user sending the command. - -.. _command-channelstats-rank: - -channelstats rank [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the ranking of users according to the given stat expression. -Valid variables in the stat expression include 'msgs', 'chars', -'words', 'smileys', 'frowns', 'actions', 'joins', 'parts', 'quits', -'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical -expression involving those variables is permitted. - -.. _command-channelstats-channelstats: - -channelstats channelstats [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the statistics for **. ** is only necessary if -the message isn't sent on the channel itself. - - - -.. _plugin-channelstats-config: - -Configuration -------------- - -.. _supybot.plugins.ChannelStats.frowns: - -supybot.plugins.ChannelStats.frowns -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [':\|', ':-/', ':-\\', ':\\', ':/', ':(', ':-(', ":'("] - -Determines what words (i.e., pieces of text with no spaces in them ) are considered 'frowns' for the purposes of stats-keeping. - -.. _supybot.plugins.ChannelStats.selfStats: - -supybot.plugins.ChannelStats.selfStats -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will keep channel statistics on itself, possibly skewing the channel stats (especially in cases where the bot is relaying between channels on a network). - -.. _supybot.plugins.ChannelStats.smileys: - -supybot.plugins.ChannelStats.smileys -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [':)', ';)', ';]', ':-)', ':-D', ':D', ':P', ':p', '(=', '=)'] - -Determines what words (i.e., pieces of text with no spaces in them) are considered 'smileys' for the purposes of stats-keeping. - -.. _supybot.plugins.ChannelStats.public: - -supybot.plugins.ChannelStats.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/coffee.rst b/use/plugins/coffee.rst deleted file mode 100644 index 896a180..0000000 --- a/use/plugins/coffee.rst +++ /dev/null @@ -1,34 +0,0 @@ - -.. _plugin-coffee: - -The Coffee plugin -================= - -.. include:: unofficial.inc - -.. _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. - diff --git a/use/plugins/conditional.rst b/use/plugins/conditional.rst deleted file mode 100644 index 4a2c304..0000000 --- a/use/plugins/conditional.rst +++ /dev/null @@ -1,167 +0,0 @@ - -.. _plugin-conditional: - -The Conditional plugin -====================== - -Numeric comparison ------------------- - -.. _command-conditional-nlt: - -conditional nlt -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a numeric comparison on ** and **. -Returns true if ** is less than **. - -.. _command-conditional-nne: - -conditional nne -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a numeric comparison on ** and **. -Returns true if they are not equal. - -.. _command-conditional-nle: - -conditional nle -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a numeric comparison on ** and **. -Returns true if ** is less than or equal to **. - -.. _command-conditional-nge: - -conditional nge -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a numeric comparison on ** and **. -Returns true if ** is greater than or equal to **. - -.. _command-conditional-nceq: - -conditional nceq -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a numeric comparison on ** and **. -Returns true if they are equal. - -.. _command-conditional-ngt: - -conditional ngt -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a numeric comparison on ** and **. -Returns true if they ** is greater than **. - -String comparison ------------------ - -.. _command-conditional-le: - -conditional le -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a string comparison on ** and **. -Returns true if ** is less than or equal to **. - -.. _command-conditional-ceq: - -conditional ceq -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a string comparison on ** and **. -Returns true if they are equal. - -.. _command-conditional-gt: - -conditional gt -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a string comparison on ** and **. -Returns true if ** is greater than **. - -.. _command-conditional-ge: - -conditional ge -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a string comparison on ** and **. -Returns true if ** is greater than or equal to **. - -.. _command-conditional-ne: - -conditional ne -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a string comparison on ** and **. -Returns true if they are not equal. - -.. _command-conditional-lt: - -conditional lt -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a string comparison on ** and **. -Returns true if ** is less than **. - -.. _command-conditional-match: - -conditional match -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Determines if ** is a substring of **. -Returns true if ** is contained in **. - -Logical operators ------------------ - -.. _command-conditional-cand: - -conditional cand [ ... ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns true if all conditions supplied evaluate to true. - -.. _command-conditional-cxor: - -conditional cxor [ ... ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns true if only one of conditions supplied evaluates to true. - -.. _command-conditional-cor: - -conditional cor [ ... ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns true if any one of conditions supplied evaluates to true. - -.. _command-conditional-cif: - -conditional cif -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Runs ** if ** evaluates to true, runs ** -if it evaluates to false. - -Use other logical operators defined in this plugin and command nesting -to your advantage here. - - - -.. _plugin-conditional-config: - -Configuration -------------- - -.. _supybot.plugins.Conditional.public: - -supybot.plugins.Conditional.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/config.rst b/use/plugins/config.rst deleted file mode 100644 index 34c9db9..0000000 --- a/use/plugins/config.rst +++ /dev/null @@ -1,98 +0,0 @@ - -.. _plugin-config: - -The Config plugin -================= - -Accessing config ----------------- - -.. _command-config-help: - -config help -^^^^^^^^^^^^^^^^^^ - -Returns the description of the configuration variable **. - -.. _command-config-default: - -config default -^^^^^^^^^^^^^^^^^^^^^ - -Returns the default value of the configuration variable **. - -.. _command-config-list: - -config list -^^^^^^^^^^^^^^^^^^^ - -Returns the configuration variables available under the given -configuration **. If a variable has values under it, it is -preceded by an '@' sign. If a variable is a 'ChannelValue', that is, -it can be separately configured for each channel using the 'channel' -command in this plugin, it is preceded by an '#' sign. - -.. _command-config-search: - -config search -^^^^^^^^^^^^^^^^^^^^ - -Searches for ** in the current configuration variables. - -.. _command-config-channel: - -config channel [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If ** is given, sets the channel configuration variable for ** -to ** for **. Otherwise, returns the current channel -configuration value of **. ** is only necessary if the -message isn't sent in the channel itself. - -.. _command-config-config: - -config config [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If ** is given, sets the value of ** to **. Otherwise, -returns the current value of **. You may omit the leading -"supybot." in the name if you so choose. - - -Maintenance ------------ - -.. _command-config-reload: - -config reload -^^^^^^^^^^^^^ - -Reloads the various configuration files (user database, channel -database, registry, etc.). - -.. _command-config-export: - -config export -^^^^^^^^^^^^^^^^^^^^^^^^ - -Exports the public variables of your configuration to **. -If you want to show someone your configuration file, but you don't -want that person to be able to see things like passwords, etc., this -command will export a "sanitized" configuration file suitable for -showing publicly. - - -.. _plugin-config-config: - -Configuration -------------- - -.. _supybot.plugins.Config.public: - -supybot.plugins.Config.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/ctcp.rst b/use/plugins/ctcp.rst deleted file mode 100644 index 473ccfc..0000000 --- a/use/plugins/ctcp.rst +++ /dev/null @@ -1,45 +0,0 @@ - -.. _plugin-ctcp: - -The Ctcp plugin -=============== - -Command -------- - -.. _command-ctcp-version: - -ctcp version [] [--nicks] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sends a CTCP VERSION to **, returning the various -version strings returned. It waits for 10 seconds before returning -the versions received at that point. If *--nicks* is given, nicks are -associated with the version strings; otherwise, only the version -strings are given. - - - -.. _plugin-ctcp-config: - -Configuration -------------- - -.. _supybot.plugins.Ctcp.public: - -supybot.plugins.Ctcp.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.Ctcp.versionWait: - -supybot.plugins.Ctcp.versionWait -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 10 - -Determines how many seconds the bot will wait after getting a version command (not a CTCP VERSION, but an actual call of the command in this plugin named "version") before replying with the results it has collected. - diff --git a/use/plugins/debian.rst b/use/plugins/debian.rst deleted file mode 100644 index 71c17d5..0000000 --- a/use/plugins/debian.rst +++ /dev/null @@ -1,91 +0,0 @@ - -.. _plugin-debian: - -The Debian plugin -================= - -.. include:: unofficial.inc - -Commands --------- - -.. _command-debian-file: - -debian file [--exact] [--mode {path,filename,exactfilename}] [--branch {oldstable,stable,testing,unstable,experimental}] [--section {main,contrib,non-free}] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the package(s) containing the **. -*--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 -^^^^^^^^^^^^^^^^ - -Returns a description of the bug with bug id **. - -.. _command-debian-stats: - -debian stats -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Reports various statistics (from http://packages.qa.debian.org/) about -**. - -.. _command-debian-incoming: - -debian incoming [--{regexp,arch} ] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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}] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the current version(s) of the Debian package **. -*--exact,* if given, means you want only the **, 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}] [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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. - diff --git a/use/plugins/dict.rst b/use/plugins/dict.rst deleted file mode 100644 index b07eb52..0000000 --- a/use/plugins/dict.rst +++ /dev/null @@ -1,76 +0,0 @@ - -.. _plugin-dict: - -The Dict plugin -=============== - -Commands --------- - -.. _command-dict-synonym: - -dict synonym [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Gets a random synonym from the Moby Thesaurus (moby-thes) database. - -If given many words, gets a random synonym for each of them. - -Quote phrases to have them treated as one lookup word. - -.. _command-dict-dict: - -dict dict [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Looks up the definition of ** on the dictd server specified by -the :ref:`supybot.plugins.Dict.server` config variable. - -.. _command-dict-random: - -dict random -^^^^^^^^^^^ - -Returns a random valid dictionary. - -.. _command-dict-dictionaries: - -dict dictionaries -^^^^^^^^^^^^^^^^^ - -Returns the dictionaries valid for the dict command. - - - -.. _plugin-dict-config: - -Configuration -------------- - -.. _supybot.plugins.Dict.default: - -supybot.plugins.Dict.default -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Determines the default dictionary the bot will ask for definitions in. If this value is '*' (without the quotes) the bot will use all dictionaries to define words. - -.. _supybot.plugins.Dict.public: - -supybot.plugins.Dict.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.Dict.server: - -supybot.plugins.Dict.server -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: dict.org - -Determines what server the bot will retrieve definitions from. - diff --git a/use/plugins/dunno.rst b/use/plugins/dunno.rst deleted file mode 100644 index 33d1272..0000000 --- a/use/plugins/dunno.rst +++ /dev/null @@ -1,31 +0,0 @@ - -.. _plugin-dunno: - -The Dunno plugin -================ - - - -.. _plugin-dunno-config: - -Configuration -------------- - -.. _supybot.plugins.Dunno.prefixNick: - -supybot.plugins.Dunno.prefixNick -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will prefix the nick of the user giving an invalid command to the "dunno" response. - -.. _supybot.plugins.Dunno.public: - -supybot.plugins.Dunno.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/erepublik.rst b/use/plugins/erepublik.rst deleted file mode 100644 index 12cce1b..0000000 --- a/use/plugins/erepublik.rst +++ /dev/null @@ -1,104 +0,0 @@ - -.. _plugin-erepublik: - -The ERepublik plugin -==================== - -.. include:: unofficial.inc - -Commands --------- - -.. _command-erepublik-info: - -erepublik info -^^^^^^^^^^^^^^^^^^^^^^^^ - -Displays informations on the given citizen. - -.. _command-erepublik-money: - -erepublik money -^^^^^^^^^^^^^^^^^^^^^^ - -Displays money's rates. - -.. _command-erepublik-fight: - -erepublik fight -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Shows how many damages you can make in one hit. - -.. _command-erepublik-see: - -erepublik see -^^^^^^^^^^^^^^^^^^^^^^^ - -Displays informations on the given citizen. - -.. _command-erepublik-land: - -erepublik land take no arguments -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the eRepublik land links. - -.. _command-erepublik-link: - -erepublik link -^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the link to the user's profile. - -.. _command-erepublik-medals: - -erepublik medals -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Displays the citizen's medals. - -.. _command-erepublik-invasion: - -erepublik invasion -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Calls for invasion of the channel. - -.. _command-erepublik-menu: - -erepublik menu take no arguments -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the eRepublik main links. - -.. _command-erepublik-kamikaze: - -erepublik kamikaze -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Shows how many damages you can make in one hit. - -.. _command-erepublik-donate: - -erepublik donate -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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. - diff --git a/use/plugins/eureka.rst b/use/plugins/eureka.rst deleted file mode 100644 index 76f4644..0000000 --- a/use/plugins/eureka.rst +++ /dev/null @@ -1,127 +0,0 @@ - -.. _plugin-eureka: - -The Eureka plugin -================= - -.. include:: unofficial.inc - -Start and stop --------------- - -.. _command-eureka-start: - -eureka start [] -^^^^^^^^^^^^^^^^^^^^^^^^ - -Start the Eureka on the given **. If ** is not given, -it defaults to the current channel. - -.. _command-eureka-stop: - -eureka stop [] -^^^^^^^^^^^^^^^^^^^^^^^ - -Stop the Eureka on the given **. If ** is not given, -it defaults to the current channel. - -.. _command-eureka-pause: - -eureka pause [] -^^^^^^^^^^^^^^^^^^^^^^^^ - -Pause the Eureka on the given **. If ** is not given, -it defaults to the current channel. - -.. _command-eureka-resume: - -eureka resume [] -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Resume the Eureka on the given **. If ** is not given, -it defaults to the current channel. - -Moderation ----------- - -.. _command-eureka-adjust: - -eureka adjust [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Increase or decrease the score of ** on the **. -If ** is not given, it defaults to the current channel. - -.. _command-eureka-skip: - -eureka skip [] -^^^^^^^^^^^^^^^^^^^^^^^ - -Give up with this question, and switch to the next one. - -.. _command-eureka-clue: - -eureka clue [] -^^^^^^^^^^^^^^^^^^^^^^^ - -Give the next clue. - -Scores ------- - -.. _command-eureka-scores: - -eureka scores [] -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Return the scores on the **. If ** is not given, it -defaults to the current channel. - -.. _command-eureka-score: - -eureka score [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Return the score of ** on the **. If ** 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. - diff --git a/use/plugins/factoids.rst b/use/plugins/factoids.rst deleted file mode 100644 index b9ce45c..0000000 --- a/use/plugins/factoids.rst +++ /dev/null @@ -1,212 +0,0 @@ - -.. _plugin-factoids: - -The Factoids plugin -=================== - -Reading factoids ----------------- - -.. _command-factoids-info: - -factoids info [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Gives information about the factoid(s) associated with **. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-factoids-random: - -factoids random [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns a random factoid from the database for **. ** -is only necessary if the message isn't sent in the channel itself. - -.. _command-factoids-search: - -factoids search [] [--values] [--{regexp} ] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Searches the keyspace for keys matching **. If *--regexp* is given, -it associated value is taken as a regexp and matched against the keys. -If *--values* is given, search the value space instead of the keyspace. - -.. _command-factoids-whatis: - -factoids whatis [] [--raw] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Looks up the value of ** in the factoid database. If given a -number, will return only that exact factoid. If '*--raw'* option is -given, no variable substitution will take place on the factoid. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-factoids-rank: - -factoids rank [] [--plain] [--alpha] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns a list of top-ranked factoid keys, sorted by usage count -(rank). If ** is not provided, the default number of factoid keys -returned is set by the rankListLength registry value. - -If *--plain* option is given, rank numbers and usage counts are not -included in output. - -If *--alpha* option is given in addition to *--plain,* keys are sorted -alphabetically, instead of by rank. - -** is only necessary if the message isn't sent in the channel -itself. - -Administration --------------- - -.. _command-factoids-learn: - -factoids learn [] WORD -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Associates ** with **. ** is only -necessary if the message isn't sent on the channel -itself. The WORD (defined in :ref:`supybot.plugins.Factoids.learnSeparator`) -is necessary to separate the -key from the value. It can be changed to another word -via the :ref:`supybot.plugins.Factoids.learnSeparator` registry value. - -.. _command-factoids-forget: - -factoids forget [] [|*] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Removes a key-fact relationship for key ** from the factoids -database. If there is more than one such relationship for this key, -a number is necessary to determine which one should be removed. -A * can be used to remove all relationships for **. - -If as a result, the key (factoid) remains without any relationships to -a factoid (key), it shall be removed from the database. - -** is only necessary if -the message isn't sent in the channel itself. - -.. _command-factoids-unlock: - -factoids unlock [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Unlocks the factoid(s) associated with ** so that they can be -removed or added to. ** is only necessary if the message isn't -sent in the channel itself. - -.. _command-factoids-alias: - -factoids alias [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Adds a new key ** for factoid associated with **. -** is only necessary if there's more than one factoid associated -with **. - -The same action can be accomplished by using the 'learn' function with -a new key but an existing (verbatim) factoid content. - -.. _command-factoids-change: - -factoids change [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Changes the factoid #** associated with ** according to -**. - -.. _command-factoids-lock: - -factoids lock [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Locks the factoid(s) associated with ** so that they cannot be -removed or added to. ** is only necessary if the message isn't -sent in the channel itself. - - - -.. _plugin-factoids-config: - -Configuration -------------- - -.. _supybot.plugins.Factoids.format: - -supybot.plugins.Factoids.format -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: $key could be $value. - -Determines the format of the response given when a factoid's value is requested. All the standard substitutes apply, in addition to "$key" for the factoid's key and "$value" for the factoid's value. - -.. _supybot.plugins.Factoids.keepRankInfo: - -supybot.plugins.Factoids.keepRankInfo -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether we keep updating the usage count for each factoid, for popularity ranking. - -.. _supybot.plugins.Factoids.learnSeparator: - -supybot.plugins.Factoids.learnSeparator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: as - -Determines what separator must be used in the learn command. Defaults to 'as' -- learn as . Users might feel more comfortable with 'is' or something else, so it's configurable. - -.. _supybot.plugins.Factoids.rankListLength: - -supybot.plugins.Factoids.rankListLength -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 20 - -Determines the number of factoid keys returned by the factrank command. - -.. _supybot.plugins.Factoids.replyApproximateSearchKeys: - -supybot.plugins.Factoids.replyApproximateSearchKeys -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -If you try to look up a nonexistent factoid, this setting make the bot try to find some possible matching keys through several approximate matching algorithms and return a list of matching keys, before giving up. - -.. _supybot.plugins.Factoids.replyWhenInvalidCommand: - -supybot.plugins.Factoids.replyWhenInvalidCommand -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will reply to invalid commands by searching for a factoid; basically making the whatis unnecessary when you want all factoids for a given key. - -.. _supybot.plugins.Factoids.showFactoidIfOnlyOneMatch: - -supybot.plugins.Factoids.showFactoidIfOnlyOneMatch -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will reply with the single matching factoid if only one factoid matches when using the search command. - -.. _supybot.plugins.Factoids.public: - -supybot.plugins.Factoids.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/filter.rst b/use/plugins/filter.rst deleted file mode 100644 index e07eeb2..0000000 --- a/use/plugins/filter.rst +++ /dev/null @@ -1,271 +0,0 @@ - -.. _plugin-filter: - -The Filter plugin -================= - -Administration --------------- - -.. _command-filter-outfilter: - -filter outfilter [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sets the outFilter of this plugin to be **. If no command is -given, unsets the outFilter. ** is only necessary if the -message isn't sent in the channel itself. - -Encoding and decoding ---------------------- - -.. _command-filter-hexlify: - -filter hexlify -^^^^^^^^^^^^^^^^^^^^^ - -Returns a hexstring from the given string; a hexstring is a string -composed of the hexadecimal value of each character in the string - -.. _command-filter-unhexlify: - -filter unhexlify -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the string corresponding to **. Obviously, -** must be a string of hexadecimal digits. - -.. _command-filter-binary: - -filter binary -^^^^^^^^^^^^^^^^^^^^ - -Returns the binary representation of **. - -.. _command-filter-unbinary: - -filter unbinary -^^^^^^^^^^^^^^^^^^^^^^ - -Returns the character representation of binary **. -Assumes ASCII, 8 digits per character. - -.. _command-filter-morse: - -filter morse -^^^^^^^^^^^^^^^^^^^ - -Gives the Morse code equivalent of a given string. - -.. _command-filter-unmorse: - -filter unmorse -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does the reverse of the morse command. - - -Colors ------- - -.. _command-filter-stripcolor: - -filter stripcolor -^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns ** stripped of all color codes. - -.. _command-filter-colorize: - -filter colorize -^^^^^^^^^^^^^^^^^^^^^^ - -Returns ** with each character randomly colorized. - -.. _command-filter-rainbow: - -filter rainbow -^^^^^^^^^^^^^^^^^^^^^ - -Returns ** colorized like a rainbow. - -Utils ------ - -.. _command-filter-shrink: - -filter shrink -^^^^^^^^^^^^^^^^^^^^ - -Returns ** with each word longer than -:ref:`supybot.plugins.Filter.shrink.minimum` being shrunken (i.e., like -"internationalization" becomes "i18n"). - -.. _command-filter-uniud: - -filter uniud -^^^^^^^^^^^^^^^^^^^ - -Returns ** rotated 180 degrees. Only really works for ASCII -printable characters. - -.. _command-filter-scramble: - -filter scramble -^^^^^^^^^^^^^^^^^^^^^^ - -Replies with a string where each word is scrambled; i.e., each internal -letter (that is, all letters but the first and last) are shuffled. - -Fun ---- - -.. _command-filter-undup: - -filter undup -^^^^^^^^^^^^^^^^^^^ - -Returns **, with all consecutive duplicated letters removed. - -.. _command-filter-hebrew: - -filter hebrew -^^^^^^^^^^^^^^^^^^^^ - -Removes all the vowels from **. (If you're curious why this is -named 'hebrew' it's because I (jemfinch) thought of it in Hebrew class, -and printed Hebrew often elides the vowels.) - -.. _command-filter-leet: - -filter leet -^^^^^^^^^^^^^^^^^^ - -Returns the l33tspeak version of ** - -.. _command-filter-lithp: - -filter lithp -^^^^^^^^^^^^^^^^^^^ - -Returns the lisping version of ** - -.. _command-filter-spellit: - -filter spellit -^^^^^^^^^^^^^^^^^^^^^ - -Returns **, phonetically spelled out. - -.. _command-filter-aol: - -filter aol -^^^^^^^^^^^^^^^^^ - -Returns ** as if an AOLuser had said it. - -.. _command-filter-squish: - -filter squish -^^^^^^^^^^^^^^^^^^^^ - -Removes all the spaces from **. - -.. _command-filter-reverse: - -filter reverse -^^^^^^^^^^^^^^^^^^^^^ - -Reverses **. - -.. _command-filter-azn: - -filter azn -^^^^^^^^^^^^^^^^^ - -Returns ** with the l's made into r's and r's made into l's. - -.. _command-filter-gnu: - -filter gnu -^^^^^^^^^^^^^^^^^ - -Returns ** as GNU/RMS would say it. - -.. _command-filter-jeffk: - -filter jeffk -^^^^^^^^^^^^^^^^^^^ - -Returns ** as if JeffK had said it himself. - - - -.. _plugin-filter-config: - -Configuration -------------- - -.. _supybot.plugins.Filter.shrink: - -supybot.plugins.Filter.shrink -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.Filter.shrink.minimum: - -supybot.plugins.Filter.shrink.minimum -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 4 - -Determines the minimum number of a letters in a word before it will be shrunken by the shrink command/filter. - -.. _supybot.plugins.Filter.spellit: - -supybot.plugins.Filter.spellit -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.Filter.spellit.replaceLetters: - -supybot.plugins.Filter.spellit.replaceLetters -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether or not to replace letters in the output of spellit. - -.. _supybot.plugins.Filter.spellit.replaceNumbers: - -supybot.plugins.Filter.spellit.replaceNumbers -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether or not to replace numbers in the output of spellit. - -.. _supybot.plugins.Filter.spellit.replacePunctuation: - -supybot.plugins.Filter.spellit.replacePunctuation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether or not to replace punctuation in the output of spellit. - -.. _supybot.plugins.Filter.public: - -supybot.plugins.Filter.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/format.rst b/use/plugins/format.rst deleted file mode 100644 index cd8aaf3..0000000 --- a/use/plugins/format.rst +++ /dev/null @@ -1,154 +0,0 @@ - -.. _plugin-format: - -The Format plugin -================= - -Capitals --------- - -.. _command-format-upper: - -format upper -^^^^^^^^^^^^^^^^^^^ - -Returns ** uppercased. - -.. _command-format-capitalize: - -format capitalize -^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns ** capitalized. - -.. _command-format-lower: - -format lower -^^^^^^^^^^^^^^^^^^^ - -Returns ** lowercased. - -.. _command-format-title: - -format title -^^^^^^^^^^^^^^^^^^^ - -Returns ** titlecased. - -Text modifications ------------------- - -.. _command-format-format: - -format format [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Expands a Python-style format string using the remaining args. Just be -sure always to use %s, not %d or %f or whatever, because all the args -are strings. - -.. _command-format-color: - -format color [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns ** with foreground color ** and background color -** (if given) - -.. _command-format-repr: - -format repr -^^^^^^^^^^^^^^^^^^ - -Returns the text surrounded by double quotes. - -.. _command-format-replace: - -format replace -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Replaces all non-overlapping occurrences of ** -with ** in **. - -.. _command-format-field: - -format field -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the *th* space-separated field of **. I.e., if text -is "foo bar baz" and ** is 2, "bar" is returned. - -.. _command-format-concat: - -format concat -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Concatenates two strings. Do keep in mind that this is *not* the same -thing as join "", since if ** contains spaces, they won't be -removed by concat. - -.. _command-format-translate: - -format translate -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Replaces ** with ** in -**. The first and second arguments must necessarily be the same -length. - -.. _command-format-cut: - -format cut -^^^^^^^^^^^^^^^^^^^^^^^^ - -Cuts ** down to ** by chopping off the rightmost characters in -excess of **. If ** is a negative number, it chops that many -characters off the end of **. - -.. _command-format-join: - -format join [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Joins all the arguments together with **. - -.. _command-format-reverse: - -format reverse -^^^^^^^^^^^^^^^^^^^^^ - -Returns ** in reverse-video. - -Text properties ---------------- - -.. _command-format-bold: - -format bold -^^^^^^^^^^^^^^^^^^ - -Returns ** bolded. - -.. _command-format-underline: - -format underline -^^^^^^^^^^^^^^^^^^^^^^^ - -Returns ** underlined. - - - -.. _plugin-format-config: - -Configuration -------------- - -.. _supybot.plugins.Format.public: - -supybot.plugins.Format.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/games.rst b/use/plugins/games.rst deleted file mode 100644 index d50aebe..0000000 --- a/use/plugins/games.rst +++ /dev/null @@ -1,68 +0,0 @@ - -.. _plugin-games: - -The Games plugin -================ - -Random ------- - -.. _command-games-dice: - -games dice d -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Rolls a die with ** number of sides ** times. -For example, 2d6 will roll 2 six-sided dice; 10d10 will roll 10 -ten-sided dice. - -.. _command-games-roulette: - -games roulette [spin] -^^^^^^^^^^^^^^^^^^^^^ - -Fires the revolver. If the bullet was in the chamber, you're dead. -Tell me to spin the chambers and I will. - -.. _command-games-eightball: - -games eightball [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Ask a question and the answer shall be provided. - -.. _command-games-coin: - -games coin -^^^^^^^^^^ - -Flips a coin and returns the result. - -Miscellaneous -------------- - -.. _command-games-monologue: - -games monologue [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the number of consecutive lines you've sent in ** -without being interrupted by someone else (i.e. how long your current -'monologue' is). ** is only necessary if the message isn't sent -in the channel itself. - - -.. _plugin-games-config: - -Configuration -------------- - -.. _supybot.plugins.Games.public: - -supybot.plugins.Games.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/github.rst b/use/plugins/github.rst deleted file mode 100644 index 5e3c01a..0000000 --- a/use/plugins/github.rst +++ /dev/null @@ -1,93 +0,0 @@ - -.. _plugin-github: - -The GitHub plugin -================= - -.. include:: unofficial.inc - -Main commands -------------- - -.. _command-github-repo-info: - -github repo info [--enable ...] [--disable ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Displays informations about **'s **. -Enable or disable features (ie. displayed data) according to the -request). - -.. _command-github-repo-search: - -github repo search [--page ] [--language ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Searches the string in the repository names database. You can -specify the page ** of the results, and restrict the search -to a particular programming **. - -Announces ---------- - -.. _command-github-announce-remove: - -github announce remove [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Don't announce the commits of the GitHub repository called -**/** in the ** anymore. -** defaults to the current channel. - -.. _command-github-announce-add: - -github announce add [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Announce the commits of the GitHub repository called -**/** in the **. -** 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. - diff --git a/use/plugins/goodfrench.rst b/use/plugins/goodfrench.rst deleted file mode 100644 index 5c8db52..0000000 --- a/use/plugins/goodfrench.rst +++ /dev/null @@ -1,44 +0,0 @@ - -.. _plugin-goodfrench: - -The GoodFrench plugin -===================== - -.. include:: unofficial.inc - -Command -------- - -.. _command-goodfrench-detect: - -goodfrench detect -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Cherche des fautes dans le **, 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. - diff --git a/use/plugins/google.rst b/use/plugins/google.rst deleted file mode 100644 index b9dbb00..0000000 --- a/use/plugins/google.rst +++ /dev/null @@ -1,146 +0,0 @@ - -.. _plugin-google: - -The Google plugin -================= - -Web search ----------- - -.. _command-google-google: - -google google [--{filter,language} ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Searches google.com for the given string. As many results as can fit -are included. *--language* accepts a language abbreviation; *--filter -accepts* a filtering level ('active', 'moderate', 'off'). - -.. _command-google-cache: - -google cache -^^^^^^^^^^^^^^^^^^ - -Returns a link to the cached version of ** if it is available. - -.. _command-google-lucky: - -google lucky [--snippet] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Does a google search, but only returns the first result. -If option *--snippet* is given, returns also the page text snippet. - -.. _command-google-fight: - -google fight [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the results of each search, in order, from greatest number -of results to least. - -Others ------- - -.. _command-google-phonebook: - -google phonebook -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Looks ** up on Google. - -.. _command-google-calc: - -google calc -^^^^^^^^^^^^^^^^^^^^^^^^ - -Uses Google's calculator to calculate the value of **. - -.. _command-google-translate: - -google translate [to] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns ** translated from ** into **. -Beware that translating to or from languages that use multi-byte -characters may result in some very odd results. - - - -.. _plugin-google-config: - -Configuration -------------- - -.. _supybot.plugins.Google.bold: - -supybot.plugins.Google.bold -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether results are bolded. - -.. _supybot.plugins.Google.colorfulFilter: - -supybot.plugins.Google.colorfulFilter -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the word 'google' in the bot's output will be made colorful (like Google's logo). - -.. _supybot.plugins.Google.defaultLanguage: - -supybot.plugins.Google.defaultLanguage -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: lang_en - -Determines what default language is used in searches. If left empty, no specific language will be requested. - -.. _supybot.plugins.Google.maximumResults: - -supybot.plugins.Google.maximumResults -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 8 - -Determines the maximum number of results returned from the google command. - -.. _supybot.plugins.Google.searchFilter: - -supybot.plugins.Google.searchFilter -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: moderate - -Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering - -.. _supybot.plugins.Google.searchSnarfer: - -supybot.plugins.Google.searchSnarfer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the search snarfer is enabled. If so, messages (even unaddressed ones) beginning with the word 'google' will result in the first URL Google returns being sent to the channel. - -.. _supybot.plugins.Google.public: - -supybot.plugins.Google.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.Google.referer: - -supybot.plugins.Google.referer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Determines the URL that will be sent to Google for the Referer field of the search requests. If this value is empty, a Referer will be generated in the following format: http://$server/$botName - diff --git a/use/plugins/gui.rst b/use/plugins/gui.rst deleted file mode 100644 index ecbc792..0000000 --- a/use/plugins/gui.rst +++ /dev/null @@ -1,42 +0,0 @@ - -.. _plugin-gui: - -The GUI plugin -============== - -.. include:: unofficial.inc - - - -.. _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. - diff --git a/use/plugins/herald.rst b/use/plugins/herald.rst deleted file mode 100644 index 4cdff2c..0000000 --- a/use/plugins/herald.rst +++ /dev/null @@ -1,150 +0,0 @@ - -.. _plugin-herald: - -The Herald plugin -================= - -User commands -------------- - -.. _command-herald-get: - -herald get [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the current herald message for ** (or the user -** is currently identified or recognized as). If ** -is not given, defaults to the user giving the command. ** -is only necessary if the message isn't sent in the channel itself. - -.. _command-herald-remove: - -herald remove [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Removes the herald message set for **, or the user -** is currently identified or recognized as. If ** -is not given, defaults to the user giving the command. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-herald-change: - -herald change [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Changes the herald message for **, or the user ** is -currently identified or recognized as, according to **. If -** is not given, defaults to the calling user. ** is only -necessary if the message isn't sent in the channel itself. - -Op commands ------------ - -.. _command-herald-default: - -herald default [] [--remove|] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If ** is given, sets the default herald to **. A ** of "" -will remove the default herald. If ** is not given, returns the -current default herald. ** is only necessary if the message -isn't sent in the channel itself. - -.. _command-herald-add: - -herald add [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sets the herald message for ** (or the user ** is -currently identified or recognized as) to **. ** is only -necessary if the message isn't sent in the channel itself. - - - -.. _plugin-herald-config: - -Configuration -------------- - -.. _supybot.plugins.Herald.heralding: - -supybot.plugins.Herald.heralding -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether messages will be sent to the channel when a recognized user joins; basically enables or disables the plugin. - -.. _supybot.plugins.Herald.default: - -supybot.plugins.Herald.default -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Sets the default herald to use. If a user has a personal herald specified, that will be used instead. If set to the empty string, the default herald will be disabled. - -.. _supybot.plugins.Herald.default.notice: - -supybot.plugins.Herald.default.notice -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the default herald will be sent as a NOTICE instead of a PRIVMSG. - -.. _supybot.plugins.Herald.default.public: - -supybot.plugins.Herald.default.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the default herald will be sent publicly. - -.. _supybot.plugins.Herald.throttle: - -supybot.plugins.Herald.throttle -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 600 - -Determines the minimum number of seconds between heralds. - -.. _supybot.plugins.Herald.throttle.afterPart: - -supybot.plugins.Herald.throttle.afterPart -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 0 - -Determines the minimum number of seconds after parting that the bot will not herald the person when he or she rejoins. - -.. _supybot.plugins.Herald.throttle.afterSplit: - -supybot.plugins.Herald.throttle.afterSplit -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 60 - -Determines the minimum number of seconds after a netsplit that the bot will not herald the users that split. - -.. _supybot.plugins.Herald.public: - -supybot.plugins.Herald.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.Herald.requireCapability: - -supybot.plugins.Herald.requireCapability -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Determines what capability (if any) is required to add/change/remove the herald of another user. - diff --git a/use/plugins/index.rst b/use/plugins/index.rst deleted file mode 100644 index e8a768a..0000000 --- a/use/plugins/index.rst +++ /dev/null @@ -1,135 +0,0 @@ -.. _main-plugins: - -*************** -Supybot plugins -*************** - -Main plugins -============ - -.. toctree:: - :maxdepth: 3 - - admin.rst - channel.rst - config.rst - misc.rst - network.rst - owner.rst - plugin.rst - user.rst - -Channel-specific plugins -======================== - -.. toctree:: - :maxdepth: 3 - - automode.rst - attackprotector.rst - badwords.rst - channellogger.rst - channelstats.rst - factoids.rst - herald.rst - karma.rst - lart.rst - limiter.rst - linkrelay.rst - moobotfactoids.rst - protector.rst - topic.rst - webstats.rst - - -Utilities -========= - -.. toctree:: - :maxdepth: 3 - - anonymous.rst - ctcp.rst - debian.rst - goodfrench.rst - later.rst - news.rst - nickcapture.rst - note.rst - relay.rst - rss.rst - seen.rst - services.rst - seeks.rst - shrinkurl.rst - string.rst - wikitrans.rst - -Internal tools -=============== - -.. toctree:: - :maxdepth: 3 - - alias.rst - dunno.rst - format.rst - plugindownloader.rst - reply.rst - scheduler.rst - success.rst - sudo.rst - 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 - nickometer.rst - praise.rst - quote.rst - quotegrabs.rst - timebomb.rst - trivia.rst - -Other plugins -============= - -.. toctree:: - :maxdepth: 3 - - 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 - wikipedia.rst diff --git a/use/plugins/internet.rst b/use/plugins/internet.rst deleted file mode 100644 index 7a91045..0000000 --- a/use/plugins/internet.rst +++ /dev/null @@ -1,46 +0,0 @@ - -.. _plugin-internet: - -The Internet plugin -=================== - -Commands --------- - -.. _command-internet-whois: - -internet whois -^^^^^^^^^^^^^^^^^^^^^^^ - -Returns WHOIS information on the registration of **. - -.. _command-internet-dns: - -internet dns -^^^^^^^^^^^^^^^^^^^^^^ - -Returns the ip of ** or the reverse DNS hostname of **. - -.. _command-internet-hexip: - -internet hexip -^^^^^^^^^^^^^^^^^^^ - -Returns the hexadecimal IP for that IP. - - - -.. _plugin-internet-config: - -Configuration -------------- - -.. _supybot.plugins.Internet.public: - -supybot.plugins.Internet.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/karma.rst b/use/plugins/karma.rst deleted file mode 100644 index 86a50a4..0000000 --- a/use/plugins/karma.rst +++ /dev/null @@ -1,128 +0,0 @@ - -.. _plugin-karma: - -The Karma plugin -================ - -Main commands -------------- - -.. _command-karma-clear: - -karma clear [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Resets the karma of ** to 0. - -.. _command-karma-most: - -karma most [] {increased,decreased,active} -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the most increased, the most decreased, or the most active -(the sum of increased and decreased) karma things. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-karma-karma: - -karma karma [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the karma of **. If ** is not given, returns the top -N karmas, where N is determined by the config variable -:ref:`supybot.plugins.Karma.rankingDisplay.` If one ** is given, returns -the details of its karma; if more than one ** is given, returns -the total karma of each of the the things. ** is only necessary -if the message isn't sent on the channel itself. - - -Maintenance ------------ - -.. _command-karma-load: - -karma load [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Loads the Karma database for ** from ** in the bot's -data directory. ** is only necessary if the message isn't sent -in the channel itself. - -.. _command-karma-dump: - -karma dump [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Dumps the Karma database for ** to ** in the bot's -data directory. ** is only necessary if the message isn't sent -in the channel itself. - - -.. _plugin-karma-config: - -Configuration -------------- - -.. _supybot.plugins.Karma.allowSelfRating: - -supybot.plugins.Karma.allowSelfRating -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether users can adjust the karma of their nick. - -.. _supybot.plugins.Karma.allowUnaddressedKarma: - -supybot.plugins.Karma.allowUnaddressedKarma -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will increase/decrease karma without being addressed. - -.. _supybot.plugins.Karma.mostDisplay: - -supybot.plugins.Karma.mostDisplay -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 25 - -Determines how many karma things are shown when the most command is called. - -.. _supybot.plugins.Karma.rankingDisplay: - -supybot.plugins.Karma.rankingDisplay -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 3 - -Determines how many highest/lowest karma things are shown when karma is called with no arguments. - -.. _supybot.plugins.Karma.response: - -supybot.plugins.Karma.response -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will reply with a success message when something's karma is increased or decreased. - -.. _supybot.plugins.Karma.simpleOutput: - -supybot.plugins.Karma.simpleOutput -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will output shorter versions of the karma output when requesting a single thing's karma. - -.. _supybot.plugins.Karma.public: - -supybot.plugins.Karma.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/lart.rst b/use/plugins/lart.rst deleted file mode 100644 index b7d5b57..0000000 --- a/use/plugins/lart.rst +++ /dev/null @@ -1,43 +0,0 @@ - -.. _plugin-lart: - -The Lart plugin -=============== - -Command -------- - -.. _command-lart-lart: - -lart lart [] [] [for ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Uses the Luser Attitude Readjustment Tool on ** (for **, -if given). If ** is given, uses that specific lart. ** is -only necessary if the message isn't sent in the channel itself. - - - -.. _plugin-lart-config: - -Configuration -------------- - -.. _supybot.plugins.Lart.showIds: - -supybot.plugins.Lart.showIds -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will show the ids of a lart when the lart is given. - -.. _supybot.plugins.Lart.public: - -supybot.plugins.Lart.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/later.rst b/use/plugins/later.rst deleted file mode 100644 index 299bca1..0000000 --- a/use/plugins/later.rst +++ /dev/null @@ -1,85 +0,0 @@ - -.. _plugin-later: - -The Later plugin -================ - -Commands --------- - -.. _command-later-notes: - -later notes [] -^^^^^^^^^^^^^^^^^^^^ - -If ** is given, replies with what notes are waiting on **, -otherwise, replies with the nicks that have notes waiting for them. - -.. _command-later-remove: - -later remove -^^^^^^^^^^^^^^^^^^^ - -Removes the notes waiting on **. - -.. _command-later-tell: - -later tell -^^^^^^^^^^^^^^^^^^^^^^^^ - -Tells ** ** the next time ** is in seen. ** can -contain wildcard characters, and the first matching nick will be -given the note. - - - -.. _plugin-later-config: - -Configuration -------------- - -.. _supybot.plugins.Later.maximum: - -supybot.plugins.Later.maximum -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 0 - -Determines the maximum number of messages to be queued for a user. If this value is 0, there is no maximum. - -.. _supybot.plugins.Later.messageExpiry: - -supybot.plugins.Later.messageExpiry -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 30 - -Determines the maximum number of days that a message will remain queued for a user. After this time elapses, the message will be deleted. If this value is 0, there is no maximum. - -.. _supybot.plugins.Later.private: - -supybot.plugins.Later.private -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether users will be notified in the first place in which they're seen, or in private. - -.. _supybot.plugins.Later.public: - -supybot.plugins.Later.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.Later.tellOnJoin: - -supybot.plugins.Later.tellOnJoin -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether users will be notified upon joining any channel the bot is in, or only upon sending a message. - diff --git a/use/plugins/limiter.rst b/use/plugins/limiter.rst deleted file mode 100644 index 6403047..0000000 --- a/use/plugins/limiter.rst +++ /dev/null @@ -1,49 +0,0 @@ - -.. _plugin-limiter: - -The Limiter plugin -================== - - - -.. _plugin-limiter-config: - -Configuration -------------- - -.. _supybot.plugins.Limiter.enable: - -supybot.plugins.Limiter.enable -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will maintain the channel limit to be slightly above the current number of people in the channel, in order to make clone/drone attacks harder. - -.. _supybot.plugins.Limiter.maximumExcess: - -supybot.plugins.Limiter.maximumExcess -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 10 - -Determines the maximum number of free spots that will be saved when limits are being enforced. This should always be larger than supybot.plugins.Limiter.limit.minimumExcess. - -.. _supybot.plugins.Limiter.minimumExcess: - -supybot.plugins.Limiter.minimumExcess -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 5 - -Determines the minimum number of free spots that will be saved when limits are being enforced. This should always be smaller than supybot.plugins.Limiter.limit.maximumExcess. - -.. _supybot.plugins.Limiter.public: - -supybot.plugins.Limiter.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/linkrelay.rst b/use/plugins/linkrelay.rst deleted file mode 100644 index 1c2d6aa..0000000 --- a/use/plugins/linkrelay.rst +++ /dev/null @@ -1,229 +0,0 @@ - -.. _plugin-linkrelay: - -The LinkRelay plugin -==================== - -.. include:: unofficial.inc - -Manage relays -------------- - -.. _command-linkrelay-add: - -linkrelay add [--from @] [--to @] [--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 ** will be relayed; if ** is not -given, everything is relayed. -If *--reciprocal* is given, another relay will be added automatically, -in the opposite direction. - -.. _command-linkrelay-remove: - -linkrelay remove [--from @] [--to @] [--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 ** will be relayed; if ** is not -given, everything is relayed. -If *--reciprocal* is given, another relay will be removed automatically, -in the opposite direction. - -.. _command-linkrelay-list: - -linkrelay list -^^^^^^^^^^^^^^ - -Returns all the defined relay links - -Substitutes ------------ - -.. _command-linkrelay-substitute: - -linkrelay substitute -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Replaces all nicks that matches the ** by the ** -string. - -.. _command-linkrelay-nosubstitute: - -linkrelay nosubstitute -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Undo a substitution. - -.. _command-linkrelay-nicks: - -linkrelay nicks [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the nicks of the people in the linked channels. -** is only necessary if the message -isn't sent on the channel itself. - - - -.. _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. - diff --git a/use/plugins/math.rst b/use/plugins/math.rst deleted file mode 100644 index a080484..0000000 --- a/use/plugins/math.rst +++ /dev/null @@ -1,80 +0,0 @@ - -.. _plugin-math: - -The Math plugin -=============== - -Conversion ----------- - -.. _command-math-base: - -math base [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Converts ** from base ** to base **. -If ** is left out, it converts to decimal. - -.. _command-math-convert: - -math convert [] to -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Converts from ** to **. If number isn't given, it -defaults to 1. For unit information, see 'units' command. - -Calculation ------------ - -.. _command-math-rpn: - -math rpn -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the value of an RPN expression. - -.. _command-math-icalc: - -math icalc -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This is the same as the calc command except that it allows integer -math, and can thus cause the bot to suck up CPU. Hence it requires -the 'trusted' capability to use. - -.. _command-math-units: - -math units [] -^^^^^^^^^^^^^^^^^^^ - -With no arguments, returns a list of measurement types, which can be -passed as arguments. When called with a type as an argument, returns -the units of that type. - -.. _command-math-calc: - -math calc -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the value of the evaluated **. The syntax is -Python syntax; the type of arithmetic is floating point. Floating -point arithmetic is used in order to prevent a user from being able to -crash to the bot with something like '10**10**10**10'. One consequence -is that large values such as '10**24' might not be exact. - - - -.. _plugin-math-config: - -Configuration -------------- - -.. _supybot.plugins.Math.public: - -supybot.plugins.Math.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/messageparser.rst b/use/plugins/messageparser.rst deleted file mode 100644 index 786565e..0000000 --- a/use/plugins/messageparser.rst +++ /dev/null @@ -1,171 +0,0 @@ - -.. _plugin-messageparser: - -The MessageParser plugin -======================== - -Administration --------------- - -.. _command-messageparser-remove: - -messageparser remove [] [--id] ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Removes the trigger for ** from the triggers database. -** is only necessary if -the message isn't sent in the channel itself. -If option *--id* specified, will retrieve by regexp id, not content. - -.. _command-messageparser-add: - -messageparser add [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Associates ** with **. ** is only -necessary if the message isn't sent on the channel -itself. Action is echoed upon regexp match, with variables $1, $2, -etc. being interpolated from the regexp match groups. - - -.. _command-messageparser-lock: - -messageparser lock [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Locks the ** so that it cannot be -removed or overwritten to. ** is only necessary if the message isn't -sent in the channel itself. - -.. _command-messageparser-unlock: - -messageparser unlock [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Unlocks the entry associated with ** so that it can be -removed or overwritten. ** is only necessary if the message isn't -sent in the channel itself. - -.. _command-messageparser-vacuum: - -messageparser vacuum [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Vacuums the database for **. -See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html -** is only necessary if the message isn't sent in -the channel itself. -First check if user has the required capability specified in plugin -config requireVacuumCapability. - -User commands -------------- - -.. _command-messageparser-show: - -messageparser show [] [--id] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Looks up the value of ** in the triggers database. -** is only necessary if the message isn't sent in the channel -itself. -If option *--id* specified, will retrieve by regexp id, not content. - -.. _command-messageparser-rank: - -messageparser rank [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns a list of top-ranked regexps, sorted by usage count -(rank). The number of regexps returned is set by the -rankListLength registry value. ** is only necessary if the -message isn't sent in the channel itself. - -.. _command-messageparser-info: - -messageparser info [] [--id] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Display information about ** in the triggers database. -** is only necessary if the message isn't sent in the channel -itself. -If option *--id* specified, will retrieve by regexp id, not content. - -.. _command-messageparser-list: - -messageparser list [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Lists regexps present in the triggers database. -** is only necessary if the message isn't sent in the channel -itself. Regexp ID listed in paretheses. - - -.. _plugin-messageparser-config: - -Configuration -------------- - -.. _supybot.plugins.MessageParser.enable: - -supybot.plugins.MessageParser.enable -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the message parser is enabled. If enabled, will trigger on regexps added to the regexp db. - -.. _supybot.plugins.MessageParser.keepRankInfo: - -supybot.plugins.MessageParser.keepRankInfo -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether we keep updating the usage count for each regexp, for popularity ranking. - -.. _supybot.plugins.MessageParser.listSeparator: - -supybot.plugins.MessageParser.listSeparator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: , - -Determines the separator used between regexps when shown by the list command. - -.. _supybot.plugins.MessageParser.rankListLength: - -supybot.plugins.MessageParser.rankListLength -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 20 - -Determines the number of regexps returned by the triggerrank command. - -.. _supybot.plugins.MessageParser.requireManageCapability: - -supybot.plugins.MessageParser.requireManageCapability -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: admin; channel,op - -Determines the capabilities required (if any) to manage the regexp database, including add, remove, lock, unlock. Use 'channel,capab' for channel-level capabilities. Note that absence of an explicit anticapability means user has capability. - -.. _supybot.plugins.MessageParser.requireVacuumCapability: - -supybot.plugins.MessageParser.requireVacuumCapability -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: admin - -Determines the capability required (if any) to vacuum the database. - -.. _supybot.plugins.MessageParser.public: - -supybot.plugins.MessageParser.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/misc.rst b/use/plugins/misc.rst deleted file mode 100644 index 3547ff8..0000000 --- a/use/plugins/misc.rst +++ /dev/null @@ -1,170 +0,0 @@ - -.. _plugin-misc: - -The Misc plugin -=============== - -Main commands -------------- - -.. _command-misc-help: - -misc help [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This command gives a useful description of what ** does. -** is only necessary if the command is in more than one plugin. - -.. _command-misc-list: - -misc list [--private] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Lists the commands available in the given plugin. If no plugin is -given, lists the public plugins available. If *--private* is given, -lists the private plugins. - -.. _command-misc-more: - -misc more [] -^^^^^^^^^^^^^^^^^^ - -If the last command was truncated due to IRC message length -limitations, returns the next chunk of the result of the last command. -If ** is given, it takes the continuation of the last command from -** instead of the person sending this message. - -Utilities ---------- - -.. _command-misc-last: - -misc last [--{from,in,on,with,without,regexp} ] [--nolimit] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the last message matching the given criteria. *--from* requires -a nick from whom the message came; *--in* requires a channel the message -was sent to; *--on* requires a network the message was sent on; *--with -requires* some string that had to be in the message; *--regexp* requires -a regular expression the message must match; *--nolimit* returns all -the messages that can be found. By default, the channel this command is -given in is searched. - -.. _command-misc-ping: - -misc ping -^^^^^^^^^ - -Checks to see if the bot is alive. - -.. _command-misc-tell: - -misc tell -^^^^^^^^^^^^^^^^^^^^^^^ - -Tells the ** whatever ** is. Use nested commands to your -benefit here. - -Getting informations about the bot ----------------------------------- - -.. _command-misc-source: - -misc source -^^^^^^^^^^^ - -Returns a URL saying where to get Supybot. - -.. _command-misc-version: - -misc version -^^^^^^^^^^^^ - -Returns the version of the current bot. - -.. _command-misc-apropos: - -misc apropos -^^^^^^^^^^^^^^^^^^^^^ - -Searches for ** in the commands currently offered by the bot, -returning a list of the commands containing that string. - - -.. _plugin-misc-config: - -Configuration -------------- - -.. _supybot.plugins.Misc.last: - -supybot.plugins.Misc.last -^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.Misc.last.nested: - -supybot.plugins.Misc.last.nested -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.Misc.last.nested.includeNick: - -supybot.plugins.Misc.last.nested.includeNick -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether or not the nick will be included in the output of last when it is part of a nested command - -.. _supybot.plugins.Misc.last.nested.includeTimestamp: - -supybot.plugins.Misc.last.nested.includeTimestamp -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether or not the timestamp will be included in the output of last when it is part of a nested command - -.. _supybot.plugins.Misc.listPrivatePlugins: - -supybot.plugins.Misc.listPrivatePlugins -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will list private plugins with the list command if given the --private switch. If this is disabled, non-owner users should be unable to see what private plugins are loaded. - -.. _supybot.plugins.Misc.listUnloadedPlugins: - -supybot.plugins.Misc.listUnloadedPlugins -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will list unloaded plugins with the list command if given the --unloaded switch. If this is disabled, non-owner users should be unable to see what unloaded plugins are available. - -.. _supybot.plugins.Misc.public: - -supybot.plugins.Misc.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.Misc.timestampFormat: - -supybot.plugins.Misc.timestampFormat -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [%H:%M:%S] - -Determines the format string for timestamps in the Misc.last command. Refer to the Python documentation for the time module to see what formats are accepted. If you set this variable to the empty string, the timestamp will not be shown. - diff --git a/use/plugins/moobotfactoids.rst b/use/plugins/moobotfactoids.rst deleted file mode 100644 index 9a29339..0000000 --- a/use/plugins/moobotfactoids.rst +++ /dev/null @@ -1,138 +0,0 @@ - -.. _plugin-moobotfactoids: - -The MoobotFactoids plugin -========================= - -Reading factoids ----------------- - -.. _command-moobotfactoids-listauth: - -moobotfactoids listauth [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Lists the keys of the factoids with the given author. Note that if an -author has an integer name, you'll have to use that author's id to use -this function (so don't use integer usernames!). ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-moobotfactoids-random: - -moobotfactoids random [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Displays a random factoid (along with its key) from the database. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-moobotfactoids-literal: - -moobotfactoids literal [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the literal factoid for the given factoid key. No parsing of -the factoid value is done as it is with normal retrieval. ** -is only necessary if the message isn't sent in the channel itself. - -.. _command-moobotfactoids-listvalues: - -moobotfactoids listvalues [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Lists the keys of the factoids whose value contains the provided text. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-moobotfactoids-factinfo: - -moobotfactoids factinfo [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the various bits of info on the factoid for the given key. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-moobotfactoids-most: - -moobotfactoids most [] {popular|authored|recent} -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Lists the most *{popular|authored|recent}* factoids. "popular" lists the -most frequently requested factoids. "authored" lists the author with -the most factoids. "recent" lists the most recently created factoids. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-moobotfactoids-listkeys: - -moobotfactoids listkeys [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Lists the keys of the factoids whose key contains the provided text. -** is only necessary if the message isn't sent in the channel -itself. - -Administration --------------- - -.. _command-moobotfactoids-lock: - -moobotfactoids lock [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Locks the factoid with the given factoid key. Requires that the user -be registered and have created the factoid originally. ** is -only necessary if the message isn't sent in the channel itself. - -.. _command-moobotfactoids-unlock: - -moobotfactoids unlock [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Unlocks the factoid with the given factoid key. Requires that the -user be registered and have locked the factoid. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-moobotfactoids-remove: - -moobotfactoids remove [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Deletes the factoid with the given key. ** is only necessary -if the message isn't sent in the channel itself. - - - -.. _plugin-moobotfactoids-config: - -Configuration -------------- - -.. _supybot.plugins.MoobotFactoids.mostCount: - -supybot.plugins.MoobotFactoids.mostCount -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 10 - -Determines how many items are shown when the 'most' command is called. - -.. _supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch: - -supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether or not the factoid value will be shown when a listkeys search returns only one factoid key. - -.. _supybot.plugins.MoobotFactoids.public: - -supybot.plugins.MoobotFactoids.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/network.rst b/use/plugins/network.rst deleted file mode 100644 index 10bdfee..0000000 --- a/use/plugins/network.rst +++ /dev/null @@ -1,103 +0,0 @@ - -.. _plugin-network: - -The Network plugin -================== - -Getting status --------------- - -.. _command-network-driver: - -network driver [] -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the current network driver for **. ** is only -necessary if the message isn't sent on the network to which this -command is to apply. - -.. _command-network-networks: - -network networks -^^^^^^^^^^^^^^^^ - -Returns the networks to which the bot is currently connected. - -.. _command-network-latency: - -network latency [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the current latency to **. ** is only necessary -if the message isn't sent on the network to which this command is to -apply. - -Running commands ----------------- - -.. _command-network-whois: - -network whois [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the WHOIS response ** gives for **. ** is -only necessary if the network is different than the network the command -is sent on. - -.. _command-network-command: - -network command [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Gives the bot ** (with its associated **s) on **. - -(Dis)connecting ---------------- - -.. _command-network-connect: - -network connect [--ssl] [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Connects to another network (which will be represented by the name -provided in **) at **. If port is not provided, it -defaults to 6667, the default port for IRC. If password is -provided, it will be sent to the server in a PASS command. If *--ssl* is -provided, an SSL connection will be attempted. - -.. _command-network-reconnect: - -network reconnect [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Disconnects and then reconnects to **. If no network is given, -disconnects and then reconnects to the network the command was given -on. If no quit message is given, uses the configured one -(:ref:`supybot.plugins.Owner.quitMsg`) or the nick of the person giving the -command. - -.. _command-network-disconnect: - -network disconnect [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Disconnects from the network represented by the network **. -If ** is given, quits the network with the given quit -message. ** is only necessary if the network is different -from the network the command is sent on. - - -.. _plugin-network-config: - -Configuration -------------- - -.. _supybot.plugins.Network.public: - -supybot.plugins.Network.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/news.rst b/use/plugins/news.rst deleted file mode 100644 index 4ae0b7a..0000000 --- a/use/plugins/news.rst +++ /dev/null @@ -1,75 +0,0 @@ - -.. _plugin-news: - -The News plugin -=============== - -Read news ---------- - -.. _command-news-old: - -news old [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the old news item for ** with **. If no number is -given, returns all the old news items in reverse order. ** is -only necessary if the message isn't sent in the channel itself. - -.. _command-news-news: - -news news [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Display the news items for ** in the format of '(#id) subject'. -If ** is given, retrieve only that news item; otherwise retrieve all -news items. ** is only necessary if the message isn't sent in -the channel itself. - -Administration --------------- - -.. _command-news-remove: - -news remove [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Removes the news item with ** from **. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-news-add: - -news add [] : -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Adds a given news item of ** to a channel with the given **. -If ** isn't 0, that news item will expire ** seconds from -now. ** is only necessary if the message isn't sent in the -channel itself. - -.. _command-news-change: - -news change [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Changes the news item with ** from ** according to the -regular expression **. ** should be of the form -s/text/replacement/flags. ** is only necessary if the message -isn't sent on the channel itself. - - - -.. _plugin-news-config: - -Configuration -------------- - -.. _supybot.plugins.News.public: - -supybot.plugins.News.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/nickcapture.rst b/use/plugins/nickcapture.rst deleted file mode 100644 index 0f51203..0000000 --- a/use/plugins/nickcapture.rst +++ /dev/null @@ -1,40 +0,0 @@ - -.. _plugin-nickcapture: - -The NickCapture plugin -====================== - - - -.. _plugin-nickcapture-config: - -Configuration -------------- - -.. _supybot.plugins.NickCapture.ison: - -supybot.plugins.NickCapture.ison -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will check occasionally if its preferred nick is in use via the ISON command. - -.. _supybot.plugins.NickCapture.ison.period: - -supybot.plugins.NickCapture.ison.period -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 600 - -Determines how often (in seconds) the bot will check whether its nick ISON. - -.. _supybot.plugins.NickCapture.public: - -supybot.plugins.NickCapture.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/nickometer.rst b/use/plugins/nickometer.rst deleted file mode 100644 index 76dddbe..0000000 --- a/use/plugins/nickometer.rst +++ /dev/null @@ -1,33 +0,0 @@ - -.. _plugin-nickometer: - -The Nickometer plugin -===================== - -Command -------- - -.. _command-nickometer-nickometer: - -nickometer nickometer [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Tells you how lame said nick is. If ** is not given, uses the -nick of the person giving the command. - - - -.. _plugin-nickometer-config: - -Configuration -------------- - -.. _supybot.plugins.Nickometer.public: - -supybot.plugins.Nickometer.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/note.rst b/use/plugins/note.rst deleted file mode 100644 index 2e9f29e..0000000 --- a/use/plugins/note.rst +++ /dev/null @@ -1,121 +0,0 @@ - -.. _plugin-note: - -The Note plugin -=============== - -Reading notes -------------- - -.. _command-note-search: - -note search [--{regexp} ] [--sent] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Searches your received notes for ones matching **. If *--regexp* is -given, its associated value is taken as a regexp and matched against -the notes. If *--sent* is specified, only search sent notes. - -.. _command-note-list: - -note list [--{old,sent}] [--{from,to} ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Retrieves the ids of all your unread notes. If *--old* is given, list -read notes. If *--sent* is given, list notes that you have sent. If -*--from* is specified, only lists notes sent to you from **. If -*--to* is specified, only lists notes sent by you to **. - -.. _command-note-next: - -note next -^^^^^^^^^ - -Retrieves your next unread note, if any. - -.. _command-note-note: - -note note -^^^^^^^^^^^^^^ - -Retrieves a single note by its unique note id. Use the 'note list' -command to see what unread notes you have. - -Sending notes -------------- - -.. _command-note-unsend: - -note unsend -^^^^^^^^^^^^^^^^ - -Unsends the note with the id given. You must be the -author of the note, and it must be unread. - -.. _command-note-reply: - -note reply -^^^^^^^^^^^^^^^^^^^^^^ - -Sends a note in reply to **. - -.. _command-note-send: - -note send ,[,[...]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sends a new note to the user specified. Multiple recipients may be -specified by separating their names by commas. - - - -.. _plugin-note-config: - -Configuration -------------- - -.. _supybot.plugins.Note.notify: - -supybot.plugins.Note.notify -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.Note.notify.onJoin: - -supybot.plugins.Note.notify.onJoin -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will notify people of their new messages when they join the channel. Normally it will notify them when they send a message to the channel, since oftentimes joins are the result of netsplits and not the actual presence of the user. - -.. _supybot.plugins.Note.notify.onJoin.repeatedly: - -supybot.plugins.Note.notify.onJoin.repeatedly -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will repeatedly notify people of their new messages when they join the channel. That means when they join the channel, the bot will tell them they have unread messages, even if it's told them before. - -.. _supybot.plugins.Note.notify.autoSend: - -supybot.plugins.Note.notify.autoSend -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 0 - -Determines the upper limit for automatically sending messages instead of notifications. I.e., if this value is 2 and there are 2 new messages to notify a user about, instead of sending a notification message, the bot will simply send those new messages. If there are 3 new messages, however, the bot will send a notification message. - -.. _supybot.plugins.Note.public: - -supybot.plugins.Note.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/owner.rst b/use/plugins/owner.rst deleted file mode 100644 index 1989507..0000000 --- a/use/plugins/owner.rst +++ /dev/null @@ -1,178 +0,0 @@ - -.. _plugin-owner: - -The Owner plugin -================ - -Plugins and commands --------------------- - -.. _command-owner-load: - -owner load [--deprecated] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Loads the plugin ** from any of the directories in -conf.:ref:`supybot.directories.plugins`; usually this includes the main -installed directory and 'plugins' in the current directory. -*--deprecated* is necessary if you wish to load deprecated plugins. - -.. _command-owner-unload: - -owner unload -^^^^^^^^^^^^^^^^^^^^^ - -Unloads the callback by name; use the 'list' command to see a list -of the currently loaded callbacks. Obviously, the Owner plugin can't -be unloaded. - -.. _command-owner-reload: - -owner reload -^^^^^^^^^^^^^^^^^^^^^ - -Unloads and subsequently reloads the plugin by name; use the 'list' -command to see a list of the currently loaded plugins. - -.. _command-owner-rename: - -owner rename -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Renames ** in ** to the **. - -.. _command-owner-unrename: - -owner unrename -^^^^^^^^^^^^^^^^^^^^^^^ - -Removes all renames in **. The plugin will be reloaded after -this command is run. - -.. _command-owner-enable: - -owner enable [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Enables the command ** for all users. If ** -if given, only enables the ** from **. This command is -the inverse of disable. - -.. _command-owner-disable: - -owner disable [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Disables the command ** for all users (including the owners). -If ** is given, only disables the ** from **. If -you want to disable a command for most users but not for yourself, set -a default capability of -plugin.command or -command (if you want to -disable the command in all plugins). - -.. _command-owner-defaultplugin: - -owner defaultplugin [--remove] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sets the default plugin for ** to **. If *--remove* is -given, removes the current default plugin for **. If no plugin -is given, returns the current default plugin set for **. See -also, :ref:`supybot.commands.defaultPlugins.importantPlugins.` - -Capabilities ------------- - -.. _command-owner-defaultcapability: - -owner defaultcapability {add|remove} -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Adds or removes (according to the first argument) ** from the -default capabilities given to users (the configuration variable -:ref:`supybot.capabilities` stores these). - -Maintenance ------------ - -.. _command-owner-reloadlocale: - -owner reloadlocale takes no argument -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Reloads the locale of the bot. - -.. _command-owner-ircquote: - -owner ircquote -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sends the raw string given to the server. - -.. _command-owner-upkeep: - -owner upkeep [] -^^^^^^^^^^^^^^^^^^^^^^ - -Runs the standard upkeep stuff (flushes and gc.collects()). If given -a level, runs that level of upkeep (currently, the only supported -level is "high", which causes the bot to flush a lot of caches as well -as do normal upkeep stuff. - -.. _command-owner-flush: - -owner flush -^^^^^^^^^^^ - -Runs all the periodic flushers in world.flushers. This includes -flushing all logs and all configuration changes to disk. - -.. _command-owner-quit: - -owner quit [] -^^^^^^^^^^^^^^^^^^^ - -Exits the bot with the QUIT message **. If ** is not given, -the default quit message (:ref:`supybot.plugins.Owner.quitMsg`) will be used. -If there is no default quitMsg set, your nick will be used. - -.. _command-owner-announce: - -owner announce -^^^^^^^^^^^^^^^^^^^^^ - -Sends ** to all channels the bot is currently on and not -lobotomized in. - -.. _command-owner-logmark: - -owner logmark -^^^^^^^^^^^^^^^^^^^^ - -Logs ** to the global Supybot log at critical priority. Useful for -marking logfiles for later searching. - - - -.. _plugin-owner-config: - -Configuration -------------- - -.. _supybot.plugins.Owner.public: - -supybot.plugins.Owner.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.Owner.quitMsg: - -supybot.plugins.Owner.quitMsg -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Determines what quit message will be used by default. If the quit command is called without a quit message, this will be used. If this value is empty, the nick of the person giving the quit command will be used. - diff --git a/use/plugins/plugin.rst b/use/plugins/plugin.rst deleted file mode 100644 index c7e150f..0000000 --- a/use/plugins/plugin.rst +++ /dev/null @@ -1,78 +0,0 @@ - -.. _plugin-plugin: - -The Plugin plugin -================= - -Authorship ----------- - -.. _command-plugin-contributors: - -plugin contributors [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Replies with a list of people who made contributions to a given plugin. -If ** is specified, that person's specific contributions will -be listed. Note: The ** is the part inside of the parentheses -in the people listing. - -.. _command-plugin-author: - -plugin author -^^^^^^^^^^^^^^^^^^^^^^ - -Returns the author of **. This is the person you should talk to -if you have ideas, suggestions, or other comments about a given plugin. - -Help ----- - -.. _command-plugin-help: - -plugin help -^^^^^^^^^^^^^^^^^^^^ - -Returns a useful description of how to use **, if the plugin has -one. - -.. _command-plugin-plugin: - -plugin plugin -^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the name of the plugin that would be used to call **. - -If it is not uniquely determined, returns list of all plugins that -contain **. - -.. _command-plugin-list: - -plugin list -^^^^^^^^^^^ - -Returns a list of the currently loaded plugins. - -.. _command-plugin-plugins: - -plugin plugins -^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the names of all plugins that contain **. - - - -.. _plugin-plugin-config: - -Configuration -------------- - -.. _supybot.plugins.Plugin.public: - -supybot.plugins.Plugin.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/plugindownloader.rst b/use/plugins/plugindownloader.rst deleted file mode 100644 index 87a4fce..0000000 --- a/use/plugins/plugindownloader.rst +++ /dev/null @@ -1,41 +0,0 @@ - -.. _plugin-plugindownloader: - -The PluginDownloader plugin -=========================== - -Commands --------- - -.. _command-plugindownloader-install: - -plugindownloader install -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Downloads and installs the ** from the **. - -.. _command-plugindownloader-repolist: - -plugindownloader repolist [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Displays the list of plugins in the **. -If ** is not given, returns a list of available -repositories. - - - -.. _plugin-plugindownloader-config: - -Configuration -------------- - -.. _supybot.plugins.PluginDownloader.public: - -supybot.plugins.PluginDownloader.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/praise.rst b/use/plugins/praise.rst deleted file mode 100644 index 0f04330..0000000 --- a/use/plugins/praise.rst +++ /dev/null @@ -1,43 +0,0 @@ - -.. _plugin-praise: - -The Praise plugin -================= - -Command -------- - -.. _command-praise-praise: - -praise praise [] [] [for ] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Praises ** (for **, if given). If ** is given, uses -that specific praise. ** is only necessary if the message isn't -sent in the channel itself. - - - -.. _plugin-praise-config: - -Configuration -------------- - -.. _supybot.plugins.Praise.showIds: - -supybot.plugins.Praise.showIds -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will show the ids of a praise when the praise is given. - -.. _supybot.plugins.Praise.public: - -supybot.plugins.Praise.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/protector.rst b/use/plugins/protector.rst deleted file mode 100644 index 290b882..0000000 --- a/use/plugins/protector.rst +++ /dev/null @@ -1,41 +0,0 @@ - -.. _plugin-protector: - -The Protector plugin -==================== - -Enforces channel capabilities (op/voice). - - -.. _plugin-protector-config: - -Configuration -------------- - -.. _supybot.plugins.Protector.enable: - -supybot.plugins.Protector.enable -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is enabled in a given channel. - -.. _supybot.plugins.Protector.immune: - -supybot.plugins.Protector.immune -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Determines what nicks the bot will consider to be immune from enforcement. These nicks will not even have their actions watched by this plugin. In general, only the ChanServ for this network will be in this list. - -.. _supybot.plugins.Protector.public: - -supybot.plugins.Protector.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/quote.rst b/use/plugins/quote.rst deleted file mode 100644 index ebd15e2..0000000 --- a/use/plugins/quote.rst +++ /dev/null @@ -1,33 +0,0 @@ - -.. _plugin-quote: - -The Quote plugin -================ - -Command -------- - -.. _command-quote-random: - -quote random [] -^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns a random quote from **. ** is only necessary if -the message isn't sent in the channel itself. - - - -.. _plugin-quote-config: - -Configuration -------------- - -.. _supybot.plugins.Quote.public: - -supybot.plugins.Quote.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/quotegrabs.rst b/use/plugins/quotegrabs.rst deleted file mode 100644 index 5bc0927..0000000 --- a/use/plugins/quotegrabs.rst +++ /dev/null @@ -1,125 +0,0 @@ - -.. _plugin-quotegrabs: - -The QuoteGrabs plugin -===================== - -Getting quotes --------------- - -.. _command-quotegrabs-get: - -quotegrabs get [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Return the quotegrab with the given **. ** is only necessary -if the message isn't sent in the channel itself. - -.. _command-quotegrabs-quote: - -quotegrabs quote [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns **'s latest quote grab in **. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-quotegrabs-random: - -quotegrabs random [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns a randomly grabbed quote, optionally choosing only from those -quotes grabbed for **. ** is only necessary if the message -isn't sent in the channel itself. - -.. _command-quotegrabs-list: - -quotegrabs list [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns a list of shortened quotes that have been grabbed for ** -as well as the id of each quote. These ids can be used to get the -full quote. ** is only necessary if the message isn't sent in -the channel itself. - -.. _command-quotegrabs-search: - -quotegrabs search [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Searches for ** in a quote. ** is only necessary if the -message isn't sent in the channel itself. - -(Un)quoting ------------ - -.. _command-quotegrabs-ungrab: - -quotegrabs ungrab [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Removes the grab ** (the last by default) on **. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-quotegrabs-grab: - -quotegrabs grab [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Grabs a quote from ** by ** for the quotegrabs table. -** is only necessary if the message isn't sent in the channel -itself. - - - -.. _plugin-quotegrabs-config: - -Configuration -------------- - -.. _supybot.plugins.QuoteGrabs.randomGrabber: - -supybot.plugins.QuoteGrabs.randomGrabber -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will randomly grab possibly-suitable quotes on occasion. The suitability of a given message is determined by ... - -.. _supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs: - -supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 864000 - -Determines about how many seconds, on average, should elapse between random grabs. This is only an average value; grabs can happen from any time after half this time until never, although that's unlikely to occur. - -.. _supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters: - -supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 8 - -Determines the minimum number of characters in a message for it to be considered for random grabbing. - -.. _supybot.plugins.QuoteGrabs.randomGrabber.minimumWords: - -supybot.plugins.QuoteGrabs.randomGrabber.minimumWords -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 3 - -Determines the minimum number of words in a message for it to be considered for random grabbing. - -.. _supybot.plugins.QuoteGrabs.public: - -supybot.plugins.QuoteGrabs.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/relay.rst b/use/plugins/relay.rst deleted file mode 100644 index 2a3af3f..0000000 --- a/use/plugins/relay.rst +++ /dev/null @@ -1,136 +0,0 @@ - -.. _plugin-relay: - -The Relay plugin -================ - -Commands --------- - -.. _command-relay-nicks: - -relay nicks [] -^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the nicks of the people in the channel on the various networks -the bot is connected to. ** is only necessary if the message -isn't sent on the channel itself. - -.. _command-relay-join: - -relay join [] -^^^^^^^^^^^^^^^^^^^^^^ - -Starts relaying between the channel ** on all networks. If on a -network the bot isn't in **, he'll join. This commands is -required even if the bot is in the channel on both networks; he won't -relay between those channels unless he's told to join both -channels. If ** is not given, starts relaying on the channel -the message was sent in. - -.. _command-relay-part: - -relay part -^^^^^^^^^^^^^^^^^^^^ - -Ceases relaying between the channel ** on all networks. The bot -will part from the channel on all networks in which it is on the -channel. - - - -.. _plugin-relay-config: - -Configuration -------------- - -.. _supybot.plugins.Relay.color: - -supybot.plugins.Relay.color -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will color relayed PRIVMSGs so as to make the messages easier to read. - -.. _supybot.plugins.Relay.hostmasks: - -supybot.plugins.Relay.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.Relay.ignores: - -supybot.plugins.Relay.ignores -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Determines what hostmasks will not be relayed on a channel. - -.. _supybot.plugins.Relay.includeNetwork: - -supybot.plugins.Relay.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.Relay.noticeNonPrivmsgs: - -supybot.plugins.Relay.noticeNonPrivmsgs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will used NOTICEs rather than PRIVMSGs for non-PRIVMSG relay messages (i.e., joins, parts, nicks, quits, modes, etc.) - -.. _supybot.plugins.Relay.punishOtherRelayBots: - -supybot.plugins.Relay.punishOtherRelayBots -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will detect other bots relaying and respond by kickbanning them. - -.. _supybot.plugins.Relay.topicSync: - -supybot.plugins.Relay.topicSync -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will synchronize topics between networks in the channels it relays. - -.. _supybot.plugins.Relay.channels: - -supybot.plugins.Relay.channels -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Determines which channels the bot will relay in. - -.. _supybot.plugins.Relay.channels.joinOnAllNetworks: - -supybot.plugins.Relay.channels.joinOnAllNetworks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will always join the channel(s) it relays for on all networks the bot is connected to. - -.. _supybot.plugins.Relay.public: - -supybot.plugins.Relay.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/reply.rst b/use/plugins/reply.rst deleted file mode 100644 index 58948ba..0000000 --- a/use/plugins/reply.rst +++ /dev/null @@ -1,64 +0,0 @@ - -.. _plugin-reply: - -The Reply plugin -================ - -Commands --------- - -.. _command-reply-notice: - -reply notice -^^^^^^^^^^^^^^^^^^^ - -Replies with ** in a notice. Use nested commands to your benefit -here. If you want a private notice, nest the private command. - -.. _command-reply-private: - -reply private -^^^^^^^^^^^^^^^^^^^^ - -Replies with ** in private. Use nested commands to your benefit -here. - -.. _command-reply-replies: - -reply replies [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Replies with each of its arguments ** in separate replies, depending -the configuration of :ref:`supybot.reply.oneToOne.` - -.. _command-reply-action: - -reply action -^^^^^^^^^^^^^^^^^^^ - -Replies with ** as an action. use nested commands to your benefit -here. - -.. _command-reply-reply: - -reply reply -^^^^^^^^^^^^^^^^^^ - -Replies with **. Equivalent to the alias, 'echo $nick: $1'. - - - -.. _plugin-reply-config: - -Configuration -------------- - -.. _supybot.plugins.Reply.public: - -supybot.plugins.Reply.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/rss.rst b/use/plugins/rss.rst deleted file mode 100644 index 0532ccd..0000000 --- a/use/plugins/rss.rst +++ /dev/null @@ -1,196 +0,0 @@ - -.. _plugin-rss: - -The RSS plugin -============== - -Reading -------- - -.. _command-rss-info: - -rss info -^^^^^^^^^^^^^^^^^^^ - -Returns information from the given RSS feed, namely the title, -URL, description, and last update date, if available. - -.. _command-rss-announce-list: - -rss announce list [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the list of feeds announced in **. ** is -only necessary if the message isn't sent in the channel itself. - -.. _command-rss-rss: - -rss rss [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Gets the title components of the given RSS feed. -If ** is given, return only that many headlines. - -Administration --------------- - -.. _command-rss-remove: - -rss remove -^^^^^^^^^^^^^^^^^ - -Removes the command for looking up RSS feeds at ** from -this plugin. - -.. _command-rss-add: - -rss add -^^^^^^^^^^^^^^^^^^^^ - -Adds a command to this plugin that will look up the RSS feed at the -given URL. - -.. _command-rss-announce-remove: - -rss announce remove [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Removes the list of feeds from the current list of announced feeds -in **. Valid feeds include the names of registered feeds as -well as URLs for RSS feeds. ** is only necessary if the -message isn't sent in the channel itself. - -.. _command-rss-announce-add: - -rss announce add [] [ ...] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Adds the list of feeds to the current list of announced feeds in -**. Valid feeds include the names of registered feeds as -well as URLs for RSS feeds. ** is only necessary if the -message isn't sent in the channel itself. - - - -.. _plugin-rss-config: - -Configuration -------------- - -.. _supybot.plugins.RSS.announcementPrefix: - -supybot.plugins.RSS.announcementPrefix -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: New news from - -Determines what prefix is prepended (if any) to the new news item announcements made in the channel. - -.. _supybot.plugins.RSS.bold: - -supybot.plugins.RSS.bold -^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will bold the title of the feed when it announces new news. - -.. _supybot.plugins.RSS.headlineSeparator: - -supybot.plugins.RSS.headlineSeparator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: || - -Determines what string is used to separate headlines in new feeds. - -.. _supybot.plugins.RSS.initialAnnounceHeadlines: - -supybot.plugins.RSS.initialAnnounceHeadlines -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 5 - -Indicates how many headlines an rss feed will output when it is first added to announce for a channel. - -.. _supybot.plugins.RSS.keywordBlacklist: - -supybot.plugins.RSS.keywordBlacklist -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Space separated list of strings, lets you filter headlines to those not containing any items in this blacklist. - -.. _supybot.plugins.RSS.keywordWhitelist: - -supybot.plugins.RSS.keywordWhitelist -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Space separated list of strings, lets you filter headlines to those containing one or more items in this whitelist. - -.. _supybot.plugins.RSS.showLinks: - -supybot.plugins.RSS.showLinks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will list the link along with the title of the feed when the rss command is called. supybot.plugins.RSS.announce.showLinks affects whether links will be listed when a feed is automatically announced. - -.. _supybot.plugins.RSS.announce: - -supybot.plugins.RSS.announce -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Determines which RSS feeds should be announced in the channel; valid input is a list of strings (either registered RSS feeds or RSS feed URLs) separated by spaces. - -.. _supybot.plugins.RSS.announce.showLinks: - -supybot.plugins.RSS.announce.showLinks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will list the link along with the title of the feed when a feed is automatically announced. - -.. _supybot.plugins.RSS.defaultNumberOfHeadlines: - -supybot.plugins.RSS.defaultNumberOfHeadlines -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 1 - -Indicates how many headlines an rss feed will output by default, if no number is provided. - -.. _supybot.plugins.RSS.feeds: - -supybot.plugins.RSS.feeds -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Determines what feeds should be accessible as commands. - -.. _supybot.plugins.RSS.public: - -supybot.plugins.RSS.public -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - -.. _supybot.plugins.RSS.waitPeriod: - -supybot.plugins.RSS.waitPeriod -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 1800 - -Indicates how many seconds the bot will wait between retrieving RSS feeds; requests made within this period will return cached results. - diff --git a/use/plugins/scheduler.rst b/use/plugins/scheduler.rst deleted file mode 100644 index eda1b16..0000000 --- a/use/plugins/scheduler.rst +++ /dev/null @@ -1,60 +0,0 @@ - -.. _plugin-scheduler: - -The Scheduler plugin -==================== - -Commands --------- - -.. _command-scheduler-repeat: - -scheduler repeat -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Schedules the command ** to run every ** seconds, -starting now (i.e., the command runs now, and every ** seconds -thereafter). ** is a name by which the command can be -unscheduled. - -.. _command-scheduler-list: - -scheduler list -^^^^^^^^^^^^^^ - -Lists the currently scheduled events. - -.. _command-scheduler-add: - -scheduler add -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Schedules the command string ** to run ** seconds in the -future. For example, 'scheduler add [seconds 30m] "echo [cpu]"' will -schedule the command "cpu" to be sent to the channel the schedule add -command was given in (with no prefixed nick, a consequence of using -echo). Do pay attention to the quotes in that example. - -.. _command-scheduler-remove: - -scheduler remove -^^^^^^^^^^^^^^^^^^^^^ - -Removes the event scheduled with id ** from the schedule. - - - -.. _plugin-scheduler-config: - -Configuration -------------- - -.. _supybot.plugins.Scheduler.public: - -supybot.plugins.Scheduler.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/seeks.rst b/use/plugins/seeks.rst deleted file mode 100644 index 68cb890..0000000 --- a/use/plugins/seeks.rst +++ /dev/null @@ -1,70 +0,0 @@ - -.. _plugin-seeks: - -The Seeks plugin -================ - -.. include:: unofficial.inc - -Command -------- - -.. _command-seeks-search: - -seeks search -^^^^^^^^^^^^^^^^^^^^ - -Searches the ** 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. - diff --git a/use/plugins/seen.rst b/use/plugins/seen.rst deleted file mode 100644 index f799bd4..0000000 --- a/use/plugins/seen.rst +++ /dev/null @@ -1,72 +0,0 @@ - -.. _plugin-seen: - -The Seen plugin -=============== - -Commands --------- - -.. _command-seen-user: - -seen user [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the last time ** was seen and what ** was last seen -saying. This looks up ** in the user seen database, which means -that it could be any nick recognized as user ** that was seen. -** is only necessary if the message isn't sent in the channel -itself. - -.. _command-seen-seen: - -seen seen [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the last time ** was seen and what ** was last seen -saying. ** is only necessary if the message isn't sent on the -channel itself. ** may contain * as a wildcard. - -.. _command-seen-any: - -seen any [] [--user ] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the last time ** was seen and what ** was last seen -doing. This includes any form of activity, instead of just PRIVMSGs. -If ** isn't specified, returns the last activity seen in -**. If *--user* is specified, looks up name in the user database -and returns the last time user was active in **. ** is -only necessary if the message isn't sent on the channel itself. - -.. _command-seen-last: - -seen last [] -^^^^^^^^^^^^^^^^^^^^^ - -Returns the last thing said in **. ** is only necessary -if the message isn't sent in the channel itself. - -.. _command-seen-since: - -seen since [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the messages since ** last left the channel. - - - -.. _plugin-seen-config: - -Configuration -------------- - -.. _supybot.plugins.Seen.public: - -supybot.plugins.Seen.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/services.rst b/use/plugins/services.rst deleted file mode 100644 index 654467a..0000000 --- a/use/plugins/services.rst +++ /dev/null @@ -1,194 +0,0 @@ - -.. _plugin-services: - -The Services plugin -=================== - -NickServ --------- - -.. _command-services-identify: - -services identify -^^^^^^^^^^^^^^^^^ - -Identifies with NickServ using the current nick. - -.. _command-services-nicks: - -services nicks -^^^^^^^^^^^^^^ - -Returns the nicks that this plugin is configured to identify and ghost -with. - -.. _command-services-password: - -services password [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sets the NickServ password for ** to **. If ** is -not given, removes ** from the configured nicks. - -.. _command-services-ghost: - -services ghost [] -^^^^^^^^^^^^^^^^^^^^^^^ - -Ghosts the bot's given nick and takes it. If no nick is given, -ghosts the bot's configured nick and takes it. - -ChanServ --------- - -.. _command-services-unban: - -services unban [] -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Attempts to get unbanned by ChanServ in **. ** is only -necessary if the message isn't sent in the channel itself, but chances -are, if you need this command, you're not sending it in the channel -itself. - -.. _command-services-invite: - -services invite [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Attempts to get invited by ChanServ to **. ** is only -necessary if the message isn't sent in the channel itself, but chances -are, if you need this command, you're not sending it in the channel -itself. - -.. _command-services-voice: - -services voice [] -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Attempts to get voiced by ChanServ in **. ** is only -necessary if the message isn't sent in the channel itself. - -.. _command-services-op: - -services op [] -^^^^^^^^^^^^^^^^^^^^^^^ - -Attempts to get opped by ChanServ in **. ** is only -necessary if the message isn't sent in the channel itself. - - - -.. _plugin-services-config: - -Configuration -------------- - -.. _supybot.plugins.Services.ChanServ: - -supybot.plugins.Services.ChanServ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Determines what nick the 'ChanServ' service has. - -.. _supybot.plugins.Services.ChanServ.halfop: - -supybot.plugins.Services.ChanServ.halfop -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will request to get half-opped by the ChanServ when it joins the channel. - -.. _supybot.plugins.Services.ChanServ.op: - -supybot.plugins.Services.ChanServ.op -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will request to get opped by the ChanServ when it joins the channel. - -.. _supybot.plugins.Services.ChanServ.password: - -supybot.plugins.Services.ChanServ.password -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Determines what password the bot will use with ChanServ. - -.. _supybot.plugins.Services.ChanServ.voice: - -supybot.plugins.Services.ChanServ.voice -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will request to get voiced by the ChanServ when it joins the channel. - -.. _supybot.plugins.Services.NickServ: - -supybot.plugins.Services.NickServ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: - -Determines what nick the 'NickServ' service has. - -.. _supybot.plugins.Services.NickServ.password: - -supybot.plugins.Services.NickServ.password -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.Services.disabledNetworks: - -supybot.plugins.Services.disabledNetworks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: ['QuakeNet'] - -Determines what networks this plugin will be disabled on. - -.. _supybot.plugins.Services.ghostDelay: - -supybot.plugins.Services.ghostDelay -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 60 - -Determines how many seconds the bot will wait between successive GHOST attempts. - -.. _supybot.plugins.Services.nicks: - -supybot.plugins.Services.nicks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -Determines what nicks the bot will use with services. - -.. _supybot.plugins.Services.noJoinsUntilIdentified: - -supybot.plugins.Services.noJoinsUntilIdentified -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will not join any channels until it is identified. This may be useful, for instances, if you have a vhost that isn't set until you're identified, or if you're joining +r channels that won't allow you to join unless you identify. - -.. _supybot.plugins.Services.public: - -supybot.plugins.Services.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/shrinkurl.rst b/use/plugins/shrinkurl.rst deleted file mode 100644 index 67e5bfe..0000000 --- a/use/plugins/shrinkurl.rst +++ /dev/null @@ -1,118 +0,0 @@ - -.. _plugin-shrinkurl: - -The ShrinkUrl plugin -==================== - -Commands --------- - -.. _command-shrinkurl-xrl: - -shrinkurl xrl -^^^^^^^^^^^^^^^^^^^ - -Returns an xrl.us version of **. - -.. _command-shrinkurl-tiny: - -shrinkurl tiny -^^^^^^^^^^^^^^^^^^^^ - -Returns a TinyURL.com version of ** - -.. _command-shrinkurl-ln: - -shrinkurl ln -^^^^^^^^^^^^^^^^^^ - -Returns an ln-s.net version of **. - - - -.. _plugin-shrinkurl-config: - -Configuration -------------- - -.. _supybot.plugins.ShrinkUrl.default: - -supybot.plugins.ShrinkUrl.default -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: ln - -Determines what website the bot will use when shrinking a URL. - -.. _supybot.plugins.ShrinkUrl.minimumLength: - -supybot.plugins.ShrinkUrl.minimumLength -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 48 - -The minimum length a URL must be before the bot will shrink it. - -.. _supybot.plugins.ShrinkUrl.nonSnarfingRegexp: - -supybot.plugins.ShrinkUrl.nonSnarfingRegexp -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: None - -Determines what URLs are to be snarfed; URLs matching the regexp given will not be snarfed. Give the empty string if you have no URLs that you'd like to exclude from being snarfed. - -.. _supybot.plugins.ShrinkUrl.outFilter: - -supybot.plugins.ShrinkUrl.outFilter -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the bot will shrink the URLs of outgoing messages if those URLs are longer than supybot.plugins.ShrinkUrl.minimumLength. - -.. _supybot.plugins.ShrinkUrl.serviceRotation: - -supybot.plugins.ShrinkUrl.serviceRotation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: [] - -If set to a non-empty value, specifies the list of services to rotate through for the shrinkSnarfer and outFilter. - -.. _supybot.plugins.ShrinkUrl.shrinkSnarfer: - -supybot.plugins.ShrinkUrl.shrinkSnarfer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the shrink snarfer is enabled. This snarfer will watch for URLs in the channel, and if they're sufficiently long (as determined by supybot.plugins.ShrinkUrl.minimumLength) it will post a smaller URL from either ln-s.net or tinyurl.com, as denoted in supybot.plugins.ShrinkUrl.default. - -.. _supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain: - -supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the snarfer will show the domain of the URL being snarfed along with the shrunken URL. - -.. _supybot.plugins.ShrinkUrl.bold: - -supybot.plugins.ShrinkUrl.bold -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin will bold certain portions of its replies. - -.. _supybot.plugins.ShrinkUrl.public: - -supybot.plugins.ShrinkUrl.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/status.rst b/use/plugins/status.rst deleted file mode 100644 index 238954c..0000000 --- a/use/plugins/status.rst +++ /dev/null @@ -1,117 +0,0 @@ - -.. _plugin-status: - -The Status plugin -================= - -Commands --------- - -.. _command-status-status: - -status status -^^^^^^^^^^^^^ - -Returns the status of the bot. - -.. _command-status-cmd: - -status cmd -^^^^^^^^^^ - -Returns some interesting command-related statistics. - -.. _command-status-commands: - -status commands -^^^^^^^^^^^^^^^ - -Returns a list of the commands offered by the bot. - -.. _command-status-uptime: - -status uptime -^^^^^^^^^^^^^ - -Returns the amount of time the bot has been running. - -.. _command-status-threads: - -status threads -^^^^^^^^^^^^^^ - -Returns the current threads that are active. - -.. _command-status-net: - -status net -^^^^^^^^^^ - -Returns some interesting network-related statistics. - -.. _command-status-server: - -status server -^^^^^^^^^^^^^ - -Returns the server the bot is on. - -.. _command-status-cpu: - -status cpu -^^^^^^^^^^ - -Returns some interesting CPU-related statistics on the bot. - - - -.. _plugin-status-config: - -Configuration -------------- - -.. _supybot.plugins.Status.cpu: - -supybot.plugins.Status.cpu -^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.Status.cpu.children: - -supybot.plugins.Status.cpu.children -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the cpu command will list the time taken by children as well as the bot's process. - -.. _supybot.plugins.Status.cpu.memory: - -supybot.plugins.Status.cpu.memory -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the cpu command will report the amount of memory being used by the bot. - -.. _supybot.plugins.Status.cpu.threads: - -supybot.plugins.Status.cpu.threads -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: False - -Determines whether the cpu command will provide the number of threads spawned and active. - -.. _supybot.plugins.Status.public: - -supybot.plugins.Status.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/string.rst b/use/plugins/string.rst deleted file mode 100644 index 64daa2b..0000000 --- a/use/plugins/string.rst +++ /dev/null @@ -1,151 +0,0 @@ - -.. _plugin-string: - -The String plugin -================= - -Hashes ------- - -.. _command-string-soundex: - -string soundex [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the Soundex hash to a given length. The length defaults to -4, since that's the standard length for a soundex hash. For unlimited -length, use 0. - -.. _command-string-sha: - -string sha -^^^^^^^^^^^^^^^^^ - -Returns the SHA hash of a given string. Read -http://www.secure-hash-algorithm-md5-sha-1.co.uk/ for more information -about SHA. - -Encoding/decoding ------------------ - -.. _command-string-xor: - -string xor -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns ** XOR-encrypted with **. See -http://www.yoe.org/developer/xor.html for information about XOR -encryption. - -.. _command-string-encode: - -string encode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns an encoded form of the given text; the valid encodings are -available in the documentation of the Python codecs module: -**. - -.. _command-string-decode: - -string decode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns an un-encoded form of the given text; the valid encodings are -available in the documentation of the Python codecs module: -**. - -.. _command-string-ord: - -string ord -^^^^^^^^^^^^^^^^^^^ - -Returns the 8-bit value of **. - -.. _command-string-chr: - -string chr -^^^^^^^^^^^^^^^^^^^ - -Returns the character associated with the 8-bit value ** - -Miscellaneous -------------- - -.. _command-string-re: - -string re -^^^^^^^^^^^^^^^^^^^^^^^^^ - -If ** is of the form m/regexp/flags, returns the portion of -** that matches the regexp. If ** is of the form -s/regexp/replacement/flags, returns the result of applying such a -regexp to **. - -.. _command-string-levenshtein: - -string levenshtein -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the levenshtein distance (also known as the "edit distance" -between ** and **) - -.. _command-string-len: - -string len -^^^^^^^^^^^^^^^^^ - -Returns the length of **. - - - -.. _plugin-string-config: - -Configuration -------------- - -.. _supybot.plugins.String.levenshtein: - -supybot.plugins.String.levenshtein -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.String.levenshtein.max: - -supybot.plugins.String.levenshtein.max -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 256 - -Determines the maximum size of a string given to the levenshtein command. The levenshtein command uses an O(m*n) algorithm, which means that with strings of length 256, it can take 1.5 seconds to finish; with strings of length 384, though, it can take 4 seconds to finish, and with strings of much larger lengths, it takes more and more time. Using nested commands, strings can get quite large, hence this variable, to limit the size of arguments passed to the levenshtein command. - -.. _supybot.plugins.String.re: - -supybot.plugins.String.re -^^^^^^^^^^^^^^^^^^^^^^^^^ - - - - - -.. _supybot.plugins.String.re.timeout: - -supybot.plugins.String.re.timeout -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: 0.1 - -Determines the maximum time, in seconds, that a regular expression is given to execute before being terminated. Since there is a possibility that user input for the re command can cause it to eat up large amounts of ram or cpu time, it's a good idea to keep this low. Most normal regexps should not take very long at all. - -.. _supybot.plugins.String.public: - -supybot.plugins.String.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/success.rst b/use/plugins/success.rst deleted file mode 100644 index a103251..0000000 --- a/use/plugins/success.rst +++ /dev/null @@ -1,31 +0,0 @@ - -.. _plugin-success: - -The Success plugin -================== - - - -.. _plugin-success-config: - -Configuration -------------- - -.. _supybot.plugins.Success.prefixNick: - -supybot.plugins.Success.prefixNick -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether the bot will prefix the nick of the user giving an invalid command to the success response. - -.. _supybot.plugins.Success.public: - -supybot.plugins.Success.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/sudo.rst b/use/plugins/sudo.rst deleted file mode 100644 index a0bc198..0000000 --- a/use/plugins/sudo.rst +++ /dev/null @@ -1,63 +0,0 @@ - -.. _plugin-sudo: - -The Sudo plugin -=============== - -.. include:: unofficial.inc - -Commands --------- - -.. _command-sudo-sudo: - -sudo sudo [ [ ...]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Runs the command following the Sudo rules. - -.. _command-sudo-remove: - -sudo remove -^^^^^^^^^^^^^^^^ - -Remove a Sudo rule. - -.. _command-sudo-fakehostmask: - -sudo fakehostmask -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Runs ** as if you were wearing the **. Of course, usage -of the command is restricted to the owner. - -.. _command-sudo-add: - -sudo add [] {allow,deny} [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sets a new Sudo rule, called ** with the given ** -(greatest numbers have precedence), -allowing or denying to run commands matching the pattern **, -from users to run commands as wearing the **. -The ** must be a relative integer. -If ** is not given, it defaults to 0. -The ** defaults to your hostmask. -The ** is only needed if you set an 'allow' rule. - - - -.. _plugin-sudo-config: - -Configuration -------------- - -.. _supybot.plugins.Sudo.public: - -supybot.plugins.Sudo.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/supyml.rst b/use/plugins/supyml.rst deleted file mode 100644 index 67392e9..0000000 --- a/use/plugins/supyml.rst +++ /dev/null @@ -1,43 +0,0 @@ - -.. _plugin-supyml: - -The SupyML plugin -================= - -.. include:: unofficial.inc - -Command -------- - -.. _command-supyml-eval: - -supyml eval [--warnings] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Executes the ** - - - -.. _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. - diff --git a/use/plugins/supysandbox.rst b/use/plugins/supysandbox.rst deleted file mode 100644 index abc803e..0000000 --- a/use/plugins/supysandbox.rst +++ /dev/null @@ -1,33 +0,0 @@ - -.. _plugin-supysandbox: - -The SupySandbox plugin -====================== - -.. include:: unofficial.inc - -Command -------- - -.. _command-supysandbox-sandbox: - -supysandbox sandbox -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Runs Python code safely thanks to pysandbox - - -.. _plugin-supysandbox-config: - -Configuration -------------- - -.. _supybot.plugins.SupySandbox.public: - -supybot.plugins.SupySandbox.public -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Default value: True - -Determines whether this plugin is publicly visible. - diff --git a/use/plugins/time.rst b/use/plugins/time.rst deleted file mode 100644 index 57101cc..0000000 --- a/use/plugins/time.rst +++ /dev/null @@ -1,96 +0,0 @@ - -.. _plugin-time: - -The Time plugin -=============== - -Relative time -------------- - -.. _command-time-ctime: - -time ctime [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the ctime for **, or the current ctime if -no ** is given. - -.. _command-time-time: - -time time [] [] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Returns the current time in ** format, or, if ** is not -given, uses the configurable format for the current channel. If no -** time is given, the current time is used. - -.. _command-time-elapsed: - -time elapsed -^^^^^^^^^^^^^^^^^^^^^^ - -Returns a pretty string that is the amount of time represented by -**. - -time until