From 1287b9d82382bf22e16edda67eae755f07397f2e Mon Sep 17 00:00:00 2001 From: "David Adam (zanchey)" Date: Sun, 12 May 2013 15:56:01 +0800 Subject: 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. --- doc_src/functions.txt | 52 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 36 insertions(+), 16 deletions(-) (limited to 'doc_src/functions.txt') diff --git a/doc_src/functions.txt b/doc_src/functions.txt index 928cd545..c1f0115e 100644 --- a/doc_src/functions.txt +++ b/doc_src/functions.txt @@ -1,31 +1,51 @@ \section functions functions - print or erase functions \subsection function-synopsis Synopsis -functions [-e] FUNCTIONS... +
functions [-n]
+functions -c OLDNAME NEWNAME
+functions -d DESCRIPTION FUNCTION
+functions [-eq] FUNCTIONS...
\subsection functions-description Description -This builtin command is used to print or erase functions. +\c functions prints or erases functions. -- -a or --all list all functions, even those whose name start with an underscore. +The following options are available: + +- -a or --all lists all functions, even those whose name start with an underscore. - -c OLDNAME NEWNAME or --copy OLDNAME NEWNAME creates a new function named NEWNAME, using the definition of the OLDNAME function. -- -d DESCRIPTION or --description=DESCRIPTION change the description of this function +- -d DESCRIPTION or --description=DESCRIPTION changes the description of this function. - -e or --erase causes the specified functions to be erased. -- -h or --help display a help message and exit -- -n or --names list only the names of all defined functions, not their definition -- -q or --query 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. +- -h or --help displays a help message and exits. +- -n or --names lists the names of all defined functions. +- -q or --query tests if the specified functions exist. + +The default behavior of functions, when called with no arguments, +is to print the names of all defined functions. Unless the \c -a option is +given, no functions starting with underscores are not included in the output. -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 +If any non-option parameters are given, 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 +Automatically loaded functions cannot 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. +Copying a function using \c -c copies only the body of the function, and +does not attach any event notifications from the original function. + +Only one function's description can be changed in a single invocation +of functions -d. + +The exit status of \c functions is the number of functions +specified in the argument list that do not exist, which can be used in +concert with the \c -q option. + +\subsection functions-example Examples + +functions -n displays a list of currently-defined functions. + +functions -c foo bar copies the \c foo function to a new function called +bar. -The exit status of the functions builtin is the number functions -specified in the argument list that do not exist. +functions -e bar erases the function bar. -- cgit v1.2.3