fish-shell/doc_src/functions.txt

\section functions functions - print or erase functions

\subsection function-synopsis Synopsis
<code>functions [-e] FUNCTIONS...</code>

\subsection functions-description Description

This builtin command is used to print or erase functions.

- <code>-a</code> or <code>--all</code> list all functions, even those whose name start with an underscore.
- <code>-c OLDNAME NEWNAME</code> or <code>--copy OLDNAME NEWNAME</code> creates a new function named NEWNAME, using the definition of the OLDNAME function.
- <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, not their definition
- <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.

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.

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.

Function copies, created with -c, will not have any event/signal/on-exit 
notifications that the original may have had.

The exit status of the functions builtin is the number functions
specified in the argument list that do not exist.
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00			`\section functions functions - print or erase functions`

			`\subsection function-synopsis Synopsis`
Documentation updates, mostly corrections and cla<rifications to the docs for a few builtins darcs-hash:20060608235811-ac50b-76b4fd54cb0911dd00f19f4a7c761f188d6ca068.gz 2006-06-09 07:58:11 +08:00			`<code>functions [-e] FUNCTIONS...</code>`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
			`\subsection functions-description Description`

			`This builtin command is used to print or erase functions.`

Documentation updates, mostly corrections and cla<rifications to the docs for a few builtins darcs-hash:20060608235811-ac50b-76b4fd54cb0911dd00f19f4a7c761f188d6ca068.gz 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.`
added '-c' option to the functions.txt docs. 2010-09-12 18:29:34 +08:00			`- <code>-c OLDNAME NEWNAME</code> or <code>--copy OLDNAME NEWNAME</code> creates a new function named NEWNAME, using the definition of the OLDNAME function.`
Documentation updates, mostly corrections and cla<rifications to the docs for a few builtins darcs-hash:20060608235811-ac50b-76b4fd54cb0911dd00f19f4a7c761f188d6ca068.gz 2006-06-09 07:58:11 +08:00			`- <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`
Fix minor null pointer bug in the set builtin, fix bug causing the -n switch to be ignored, add missing completions for the -n switch to functions and set builtins, and touch up the documentation for said builtin a bit darcs-hash:20060831154400-ac50b-dddbee79481e0e0a8da9fc025e8a15c466460a2f.gz 2006-08-31 23:44:00 +08:00			`- <code>-n</code> or <code>--names</code> list only the names of all defined functions, not their definition`
Add -q/--query switch to the functions builtin. Works just like the same switch to set does. Useful for checking for the existance of functions in a script darcs-hash:20060712174655-ac50b-14a98a15751bb5ddddf4ffb41521b616bef5e40c.gz 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.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
Add -q/--query switch to the functions builtin. Works just like the same switch to set does. Useful for checking for the existance of functions in a script darcs-hash:20060712174655-ac50b-14a98a15751bb5ddddf4ffb41521b616bef5e40c.gz 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`
remove trialing spaces #2 2010-09-18 10:18:26 +08:00			`functions are printed.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
Add -q/--query switch to the functions builtin. Works just like the same switch to set does. Useful for checking for the existance of functions in a script darcs-hash:20060712174655-ac50b-14a98a15751bb5ddddf4ffb41521b616bef5e40c.gz 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.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
added '-c' option to the functions.txt docs. 2010-09-12 18:29:34 +08:00			`Function copies, created with -c, will not have any event/signal/on-exit`
			`notifications that the original may have had.`

Add -q/--query switch to the functions builtin. Works just like the same switch to set does. Useful for checking for the existance of functions in a script darcs-hash:20060712174655-ac50b-14a98a15751bb5ddddf4ffb41521b616bef5e40c.gz 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.`