aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/alias.txt
blob: 84288c18ed3d2e0d9944dafad555a98eadbd050e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
\section alias alias - create a function

\subsection alias-synopsis Synopsis
<pre>alias NAME DEFINITION
alias NAME=DEFINITION</pre>

\subsection alias-description Description

\c alias is a simple wrapper for the \c function builtin.
It exists for backwards compatibility with Posix
shells. For other uses, it is recommended to define a <a
href='#function'>function</a>.

\c fish does not keep track of which functions have been defined using
\c alias. They must be erased using <code>functions -e</code>.

- NAME is the name of the alias
- DEFINITION is the actual command to execute. The string " $argv" will be appended.

You cannot create an alias to a function with the same name.

\subsection alias-example Example

The following code will create \c rmi, which runs \c rm with additional
arguments on every invocation.

<code>alias rmi "rm -i"</code>

This is equivalent to entering the following function:

<pre>function rmi
    rm -i $argv
end</pre>