2005-09-20 21:31:55 +08:00
\section functions functions - print or erase functions
\subsection function-synopsis Synopsis
2006-06-09 07:58:11 +08:00
<code>functions [-e] FUNCTIONS...</code>
2005-09-20 21:31:55 +08:00
\subsection functions-description Description
This builtin command is used to print or erase functions.
2006-06-09 07:58:11 +08:00
- <code>-a</code> or <code>--all</code> list all functions, even those whose name start with an underscore.
- <code>-d DESCRIPTION</code> or <code>--description=DESCRIPTION</code> change the description of this function
- <code>-e</code> or <code>--erase</code> causes the specified functions to be erased.
- <code>-h</code> or <code>--help</code> display a help message and exit
- <code>-n</code> or <code>--names</code> list only the names of all defined functions
2006-07-13 01:46:55 +08:00
- <code>-q</code> or <code>--query</code> test if the specified functions exist. Does not output anything, but the builtins exit status is the number of functions specified that were not defined.
2005-09-20 21:31:55 +08:00
2006-07-13 01:46:55 +08:00
The default behavior of \c functions when called with no arguments,
is to print the names and definitions of all defined functions. If any
non-switch parameters are given, only the definition of the specified
functions are printed.
2005-09-20 21:31:55 +08:00
2006-07-13 01:46:55 +08:00
Automatically loaded functions can not be removed using functions
-e. Either remove the definition file or change the
$fish_function_path variable to remove autoloaded functions.
2005-09-20 21:31:55 +08:00
2006-07-13 01:46:55 +08:00
The exit status of the functions builtin is the number functions
specified in the argument list that do not exist.
