Perl-fu Version 2
Main |
Documentation | Command List |
Download
Following is a list of commands, organized by the module/plug-in
they belong to. What they do, and the correct syntax with which to use them.
Built-in factoid management as well as bundled (standard) plug-in commands may
be found here, plug-ins contributed by outside sources probably are not
included. All commands, unless stated otherwise, are case insensitive.
Syntax Help:
| Symbol |
Meaning |
| [ ... ] |
Tokens inside square brackets are considered
optional. |
| ( ... ) |
Parentheses are used to group things. They are
usually involved in alternations |
| < ... > |
Angle brackets indicated arguments. Usually a
short description of the argument is enclosed within the brackets. |
| < ... ?> |
Angle brackets ending in a question mark
indicate optional commands. |
| | |
Used to separate different choices. |
| Argument Type |
Description |
| fname |
A string containing the name of a factoid. |
| fdesc |
A string containing the description (definition) of a factoid. |
| flevel |
An integer representing an access level of a factoid. |
| is |
A string containing a form of the verb to be. |
| regex |
A Perl regular expression |
| string |
A string |
| like |
An SQL expression suitable for being used in a LIKE clause. That is, a
string with %'s for wildcards. |
| nickmask |
A string with the nickname, username, and hostmask in nick!user@host
format. |
Factoid Manager Commands:
no, <fname> <is> <fdesc>
Overwrites the the <FName> factoid with the new <FDesc>
<fname> <is> also <fdesc>
Appends <fdesc> to the end of <fname> using "and" for a connection word.
forget <fname>
Deletes <fname> from the factoid database.
literal <fname>
Displays a factoid's literal definition, without interpolation.
fact[oid] (find | search) <like>
Searches the factoid data base for factoids that match the <like>
expression.
fact[oid] info[rmation] <fname>
Displays various information about <fname>.
set fact[oid] [access] level <fname> <flevel>
Sets <fname>'s access level to <flevel>. If <fname> is multiple words, it
must be quoted.
<fname> =~ s/regex/string/[gxims][;]
Performs an adapted version of the replacement operator s/// on <fname>'s
definiton.
Admin Plug-in Commands
[bot] settings
Displays all the current values of all the current settings, as they
appear in the setup file.
connect <server>(:| )<port> <nickname> <username> <ircname>
Spawns a new client and attempts to connect to the given server and port
with said arguments.
ignore <nickmask>
Ignores a nickmask, containing optional wildcards * and ?.
ignore list
Displays a list of all ignored nickmasks.
join <channel> <key?>
Attempts to join a channel with an optional key.
part <channel>
Leaves a channel.
reload plugins
Refreshes the plug-in library.
set <setting> = <value>
Assigns a new value to a setting.
set user level <nickmask> = <level>
Assigns a new access level to a nickmask, containing optional wildcards *
and ?.
unignore <nickmask>
Takes a nickmask, as it appears on the ignore list, off of the
list of nickmasks to ignore.
user level <nickmask>
Displays the user level of a certain individual, the nickmask should not
contain wildcards.
Calculate Plug-in Commands
calc[ulate] <expression>
Returns the value of a mathematial expression.
Karma Plug-in Commands
<target>++
Increments the karma value for <target>. If target is multiple words, it
should be quoted in single or double quotes, or enclosed in parentheses or
curly brackets.
<target>--
Decrements the karma value for <target>. If target is multiple words, it
should be quoted in single or double quotes, or enclosed in parentheses or
curly brackets.
(karma | score) [for] <target>
Displays the karma value for <target>
Modinfo Plug-in Commands
mod[ule ]info[rmation] /<pattern>/
Looks for module matches on the CPAN. <pattern> is NOT a Perl regular
expression, but rather a string containing optional wildcards * and ?.
mod[ule ]info[rmation] <modulename>
Looks for module matches on the CPAN.
Seen Plug-in Commands
seen <nickname>
Displays information about <nickname>'s recent activity as the bot
observed it.
Translate Plug-in Commands
trans[late] [from] <lang> to <lang> <phrase>
Uses babblefish to translate <phrase> from one language to another. <lang>
may be either an English spelling of a language, such as "German" or
"Spanish", it may be a two-letter abbreviation of a language, such as "de"
or "sp".
say <phrase> in <lang>
Uses babblefish to translate <phrase> from English to another language.
It is identical to: translate from English to <lang> <phrase>.
|
