mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2025-02-20 07:30:58 +01:00
44 lines
822 B
ReStructuredText
44 lines
822 B
ReStructuredText
|
|
||
|
|
.. _plugin-alias:
|
||
|
|
|
||
|
|
The Alias plugin
|
||
|
|
================
|
||
|
|
|
||
|
|
.. command-lock:
|
||
|
|
|
||
|
|
lock <alias>
|
||
|
|
^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Locks an alias so that no one else can change it.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-unlock:
|
||
|
|
|
||
|
|
unlock <alias>
|
||
|
|
^^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Unlocks an alias so that people can define new aliases over it.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-remove:
|
||
|
|
|
||
|
|
remove <name>
|
||
|
|
^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Removes the given alias, if unlocked.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-add:
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
|