diff options
| author |  axel <axel@liljencrantz.se> | 2006-06-09 09:58:11 +1000 |
|---|---|---|
| committer | axel <axel@liljencrantz.se> | 2006-06-09 09:58:11 +1000 |
| commit | d79e8c7f62472c5f47871d1ad8351ce848b2c6b4 (patch) | |
| tree | caf23bc67fde6a3708634ab335c46af626c4401b /doc_src/functions.txt | |
| parent | af8cb6fe875898d9a8c2254361bed04583c35961 (diff) | |
Documentation updates, mostly corrections and cla<rifications to the docs for a few builtins
darcs-hash:20060608235811-ac50b-76b4fd54cb0911dd00f19f4a7c761f188d6ca068.gz
Diffstat (limited to 'doc_src/functions.txt')
| -rw-r--r-- | doc_src/functions.txt | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc_src/functions.txt b/doc_src/functions.txt index 5751fb71..9def5791 100644 --- a/doc_src/functions.txt +++ b/doc_src/functions.txt @@ -1,17 +1,22 @@ \section functions functions - print or erase functions \subsection function-synopsis Synopsis -<tt>functions [-e] FUNCTIONS...</tt> +<code>functions [-e] FUNCTIONS...</code> \subsection functions-description Description This builtin command is used to print or erase functions. -- <tt>-e</tt> or <tt>--erase</tt> causes the specified functions to be erased. -- <tt>-n</tt> or <tt>--names</tt> List only the names of all defined functions +- <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 If \c functions is called with no arguments, the names and definition of all functions are printed, otherwise, the specified function definitions will be printed. +If a function is automatically loaded, using <code>functions -e</code> +to erase it will not remove the function. |