dfhack/docs/builtins/alias.rst

37 lines
947 B
ReStructuredText

2022-07-18 11:58:35 -06:00
alias
=====
Tags: `tag/system`
:dfhack-keybind:`alias`
2022-07-18 11:58:35 -06:00
:index:`Configure helper aliases for other DFHack commands.
<alias; Configure helper aliases for other DFHack commands.>` 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.
2022-07-18 11:58:35 -06:00
Usage:
- ``alias list``
Lists all configured aliases
2022-07-18 11:58:35 -06:00
- ``alias add <name> <command> [arguments...]``
Adds an alias
2022-07-18 11:58:35 -06:00
- ``alias replace <name> <command> [arguments...]``
Replaces an existing alias with a new command, or adds the alias if it does
not already exist
2022-07-18 11:58:35 -06:00
- ``alias delete <name>``
Removes the specified alias
2022-07-18 11:58:35 -06:00
Aliases can be given additional arguments when created and invoked, which will
be passed to the underlying command in order.
Example
-------
::
2022-07-18 11:58:35 -06:00
[DFHack]# alias add pargs devel/print-args example
[DFHack]# pargs text
example
text