37 lines
880 B
ReStructuredText
37 lines
880 B
ReStructuredText
alias
|
|
=====
|
|
|
|
.. dfhack-tool::
|
|
:summary: Configure helper aliases for other DFHack commands.
|
|
:tags: dfhack
|
|
|
|
Aliases are resolved immediately after built-in commands, which means that an
|
|
alias cannot override a built-in command, but can override a command implemented
|
|
by a plugin or script.
|
|
|
|
Usage
|
|
-----
|
|
|
|
``alias list``
|
|
Lists all configured aliases
|
|
``alias add <name> <command> [arguments...]``
|
|
Adds an alias
|
|
``alias replace <name> <command> [arguments...]``
|
|
Replaces an existing alias with a new command, or adds the alias if it does
|
|
not already exist
|
|
``alias delete <name>``
|
|
Removes the specified alias
|
|
|
|
Aliases can be given additional arguments when created and invoked, which will
|
|
be passed to the underlying command in order.
|
|
|
|
Example
|
|
-------
|
|
|
|
::
|
|
|
|
[DFHack]# alias add pargs devel/print-args example
|
|
[DFHack]# pargs text
|
|
example
|
|
text
|