aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/funced.txt
diff options
context:
space:
mode:
authorGravatar Mark Griffiths <mark@thebespokepixel.com>2014-08-01 03:37:32 +0100
committerGravatar Mark Griffiths <mark@thebespokepixel.com>2014-09-03 14:43:24 +0100
commitd282bc462578a6e47747c78d2d42883530f0d11e (patch)
treea6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/funced.txt
parent1c4223889bd729ee83aa21a3450dc28f92ade641 (diff)
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
Diffstat (limited to 'doc_src/funced.txt')
-rw-r--r--doc_src/funced.txt16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc_src/funced.txt b/doc_src/funced.txt
index 8b070b97..82f2cd63 100644
--- a/doc_src/funced.txt
+++ b/doc_src/funced.txt
@@ -1,21 +1,23 @@
\section funced funced - edit a function interactively
\subsection funced-synopsis Synopsis
- <code>funced [OPTIONS] NAME</code>
+\fish{syn}
+funced [OPTIONS] NAME
+\endfish
\subsection funced-description Description
-\c funced provides an interface to edit the definition of the function
-<code>NAME</code>.
+`funced` provides an interface to edit the definition of the function
+`NAME`.
-If the \c $EDITOR environment variable is set, it will be used as the program
+If the `$EDITOR` environment variable is set, it will be used as the program
to edit the function. Otherwise, a built-in editor will be used.
-If there is no function called \c NAME a new function will be created with
+If there is no function called `NAME` a new function will be created with
the specified name
-- <code>-e command</code> or <code>--editor command</code> Open the function
+- `-e command` or `--editor command` Open the function
body inside the text editor given by the command (for example, "vi"). The
command 'fish' will use the built-in editor.
-- <code>-i</code> or <code>--interactive</code> Open function body in the
+- `-i` or `--interactive` Open function body in the
built-in editor.