fish/doc_src/alias.txt

\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>
Update documentation display code to run roff on the client system instead of pregenerating documentation and compiling it into program binaries darcs-hash:20061117162438-ac50b-5c4c7f0bd8bf53a16e16ecfead9569e642b7160f.gz 2006-11-18 02:24:38 +10:00			`\section alias alias - create a function`

			`\subsection alias-synopsis Synopsis`
Update user documentation - add section on internal completion functions, update todo list, minor documentation tweaks darcs-hash:20061206000810-ac50b-08f12efdb74224abe46301d3722cd8180d8ba37d.gz 2006-12-06 10:08:10 +10:00			`<pre>alias NAME DEFINITION`
			`alias NAME=DEFINITION</pre>`
Update documentation display code to run roff on the client system instead of pregenerating documentation and compiling it into program binaries darcs-hash:20061117162438-ac50b-5c4c7f0bd8bf53a16e16ecfead9569e642b7160f.gz 2006-11-18 02:24:38 +10:00
			`\subsection alias-description Description`

Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`\c alias is a simple wrapper for the \c function builtin.`
Update documentation display code to run roff on the client system instead of pregenerating documentation and compiling it into program binaries darcs-hash:20061117162438-ac50b-5c4c7f0bd8bf53a16e16ecfead9569e642b7160f.gz 2006-11-18 02:24:38 +10:00			`It exists for backwards compatibility with Posix`
			`shells. For other uses, it is recommended to define a <a`
			`href='#function'>function</a>.`

Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`\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>`
Update user documentation - add section on internal completion functions, update todo list, minor documentation tweaks darcs-hash:20061206000810-ac50b-08f12efdb74224abe46301d3722cd8180d8ba37d.gz 2006-12-06 10:08:10 +10:00