mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-27 21:33:09 +00:00
629a39b45b
Completely fixes #1557 and the underlying Doxygen changes that caused it. Should make fish docs simpler and more robust, more consistent and generally prettier. todo: - trap unmarked text as arguments in context - test & fix sed portability - see in particular. (so far tested on BSD (Mac) and GNU sed). - test Makefile changes - last round of aesthetic changes and getting that ascii fish in there…
32 lines
952 B
Text
32 lines
952 B
Text
\section alias alias - create a function
|
|
|
|
\subsection alias-synopsis Synopsis
|
|
\fish{synopsis}
|
|
alias NAME DEFINITION
|
|
alias NAME=DEFINITION
|
|
\endfish
|
|
|
|
\subsection alias-description Description
|
|
|
|
`alias` is a simple wrapper for the `function` builtin. It exists for backwards compatibility with Posix shells. For other uses, it is recommended to define a <a href='#function'>function</a>.
|
|
|
|
`fish` does not keep track of which functions have been defined using `alias`. 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.
|
|
|
|
You cannot create an alias to a function with the same name.
|
|
|
|
\subsection alias-example Example
|
|
|
|
The following code will create `rmi`, which runs `rm` with additional arguments on every invocation.
|
|
|
|
\fish
|
|
alias rmi "rm -i"
|
|
|
|
# This is equivalent to entering the following function:
|
|
|
|
function rmi
|
|
rm -i $argv
|
|
end
|
|
\endfish
|