dfhack/docs/builtins/alias.rst

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
move builtin docs to individual files 2022-07-18 11:58:35 -06:00			`alias`
reformat builtins and properly read tags 2022-07-20 00:01:25 -06:00			`=====`
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00
			`.. dfhack-tool::`
			`:summary: Configure helper aliases for other DFHack commands.`
revise tag list and assignments 2022-08-12 00:34:37 -06:00			`:tags: dfhack`
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00
			`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.`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
make Usage a proper header 2022-08-17 23:42:02 -06:00			`Usage`
			`-----`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``alias list``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			`Lists all configured aliases`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``alias add <name> <command> [arguments...]``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			`Adds an alias`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``alias replace <name> <command> [arguments...]``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			`Replaces an existing alias with a new command, or adds the alias if it does`
			`not already exist`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``alias delete <name>``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			`Removes the specified alias`
move builtin docs to individual files 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.`

reformat builtins and properly read tags 2022-07-20 00:01:25 -06:00			`Example`
			`-------`

			`::`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
			`[DFHack]# alias add pargs devel/print-args example`
			`[DFHack]# pargs text`
			`example`
			`text`