diff options
author | David Adam (zanchey) <zanchey@ucc.gu.uwa.edu.au> | 2013-05-12 15:56:01 +0800 |
---|---|---|
committer | ridiculousfish <corydoras@ridiculousfish.com> | 2013-05-13 01:48:20 -0700 |
commit | 1287b9d82382bf22e16edda67eae755f07397f2e (patch) | |
tree | 811814b029d65ac11a193e616ca4a71d216dbe0c /doc_src/alias.txt | |
parent | 91aab03b90a6b583a3c0ecff5b015c6066d34f28 (diff) |
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.
Diffstat (limited to 'doc_src/alias.txt')
-rw-r--r-- | doc_src/alias.txt | 26 |
1 files changed, 21 insertions, 5 deletions
diff --git a/doc_src/alias.txt b/doc_src/alias.txt index 2ab277e9..84288c18 100644 --- a/doc_src/alias.txt +++ b/doc_src/alias.txt @@ -6,13 +6,29 @@ alias NAME=DEFINITION</pre> \subsection alias-description Description -Alias is a shellscript wrapper around the function builtin. +\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>. -Alias does not keep track of which functions have been defined using -alias, nor does it allow erasing of aliases. +\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> -- NAME is the name of the function to define -- DEFINITION is the body of the function. The string " $argv" will be appended to the body. |