fish-shell/sphinx_doc_src/cmds/alias.rst

49 lines
1.7 KiB
ReStructuredText
Raw Normal View History

alias - create a function
=========================
Synopsis
--------
alias
alias [OPTIONS] NAME DEFINITION
alias [OPTIONS] NAME=DEFINITION
Description
-----------
2019-03-30 19:44:07 +00:00
``alias`` is a simple wrapper for the ``function`` builtin, which creates a function wrapping a command. It has similar syntax to POSIX shell ``alias``. For other uses, it is recommended to define a `function <cmds/function.html>`__.
``fish`` marks functions that have been created by ``alias`` by including the command used to create them in the function description. You can list ``alias``-created functions by running ``alias`` without arguments. They must be erased using ``functions -e``.
- ``NAME`` is the name of the alias
- ``DEFINITION`` is the actual command to execute. The string ``$argv`` will be appended.
2019-03-29 19:15:59 +00:00
You cannot create an alias to a function with the same name. Note that spaces need to be escaped in the call to ``alias`` just like at the command line, *even inside quoted parts*.
The following options are available:
- ``-h`` or ``--help`` displays help about using this command.
2019-03-30 19:44:07 +00:00
- ``-s`` or ``--save`` Automatically save the function created by the alias into your fish configuration directory using `funcsave <cmds/funcsave.html>`__.
Example
-------
The following code will create ``rmi``, which runs ``rm`` with additional arguments on every invocation.
2018-12-19 03:14:04 +00:00
::
alias rmi="rm -i"
# This is equivalent to entering the following function:
function rmi --wraps rm --description 'alias rmi=rm -i'
rm -i $argv
end
# This needs to have the spaces escaped or "Chrome.app..." will be seen as an argument to "/Applications/Google":
alias chrome='/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome banana'