aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/funced.txt
diff options
context:
space:
mode:
authorGravatar ridiculousfish <corydoras@ridiculousfish.com>2012-06-29 18:41:37 -0700
committerGravatar ridiculousfish <corydoras@ridiculousfish.com>2012-06-29 18:41:37 -0700
commit3ab26a5d40a554606b6ca41442aa14e975900332 (patch)
tree43a15bcceabbe0a75c6553a946467354f975d173 /doc_src/funced.txt
parenta8bae31939b47363bfc07af837562247e6a9323f (diff)
Updated funced documentation to reflect new behavior
Diffstat (limited to 'doc_src/funced.txt')
-rw-r--r--doc_src/funced.txt8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc_src/funced.txt b/doc_src/funced.txt
index 91087c40..1d6daf66 100644
--- a/doc_src/funced.txt
+++ b/doc_src/funced.txt
@@ -1,11 +1,13 @@
\section funced funced - edit a function interactively
\subsection funced-synopsis Synopsis
- <code>funced [-e] NAME</code>
+ <code>funced [-e editor] NAME</code>
\subsection funced-description Description
Use the funced command to interactively edit the definition of a
-function. If there is no function with the name specified, a skeleton function is inserted, if a function exist, the definion will be shown on the command line.
+function. If there is no function with the name specified, a skeleton function is inserted, if a function exist, the definion will be shown in your editor or on the command line.
-- <code>-e</code> or <code>--editor</code> open function body inside external editor
+By default, funced edits functions using the text editor in your $EDITOR variable, if set; otherwise it uses the built-in editor.
+
+- <code>-e command</code> or <code>--editor command</code> Open the function body inside the text editor given by the command (for example, "vi"). The command 'fish' will use the built-in editor.