Limnoria-doc/use/plugins/alias.rst

46 lines
910 B
ReStructuredText
Raw Normal View History

2011-06-28 08:11:32 +02:00
.. _plugin-alias:
The Alias plugin
================
2011-06-28 17:29:38 +02:00
Protecting
----------
2011-06-29 19:17:50 +02:00
.. _command-alias-lock:
2011-06-28 08:11:32 +02:00
lock <alias>
^^^^^^^^^^^^
Locks an alias so that no one else can change it.
2011-06-29 19:17:50 +02:00
.. _command-alias-unlock:
2011-06-28 08:11:32 +02:00
unlock <alias>
^^^^^^^^^^^^^^
Unlocks an alias so that people can define new aliases over it.
2011-06-28 17:29:38 +02:00
Adding and removing
-------------------
2011-06-28 08:11:32 +02:00
2011-06-29 19:17:50 +02:00
.. _command-alias-add:
2011-06-28 08:11:32 +02:00
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.
2011-06-29 19:17:50 +02:00
.. _command-alias-remove:
2011-06-28 17:29:38 +02:00
remove <name>
^^^^^^^^^^^^^
Removes the given alias, if unlocked.
2011-06-28 08:11:32 +02:00