Limnoria-doc/use/plugins/alias.rst
2011-10-28 22:49:04 +02:00

1.2 KiB

The Alias plugin

Protecting

lock <alias>

Locks an alias so that no one else can change it.

unlock <alias>

Unlocks an alias so that people can define new aliases over it.

Adding and removing

add <name> <alias>

Defines an alias <name> that executes <alias>. The <alias> 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.

remove <name>

Removes the given alias, if unlocked.

Configuration

supybot.plugins.Alias.aliases

supybot.plugins.Alias.public

Default value: True

Determines whether this plugin is publicly visible.