aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/bind.txt
diff options
context:
space:
mode:
authorGravatar axel <axel@liljencrantz.se>2006-09-20 00:52:03 +1000
committerGravatar axel <axel@liljencrantz.se>2006-09-20 00:52:03 +1000
commit7a5823fd605af80df483e1d3f3629e60503488de (patch)
tree714e61c3c6cddec3eb7499e99121de2f3efdcb4e /doc_src/bind.txt
parent81d61c467b2fc42e7e890198fb2bd203b27aff44 (diff)
Documentation updates from Beni Cherniavsky
darcs-hash:20060919145203-ac50b-bc87b8f5e6a18395e4bc3e364da4a40ad97850e7.gz
Diffstat (limited to 'doc_src/bind.txt')
-rw-r--r--doc_src/bind.txt13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc_src/bind.txt b/doc_src/bind.txt
index 54e0cd9f..b5645182 100644
--- a/doc_src/bind.txt
+++ b/doc_src/bind.txt
@@ -1,14 +1,21 @@
\section bind bind - Handle key bindings.
\subsection bind-synopsis Synopsis
-<tt>bind [OPTIONS] [BINDINGS...] </tt>
+<tt>bind [OPTIONS] [BINDINGS...]</tt>
-The <tt>bind</tt> builtin causes fish to add the readline style bindings specified by <tt>BINDINGS</tt> to the list of key bindings. For more information on specifying keyboard bindings, use <tt>man readline</tt> to access the readline documentation.
+The <tt>bind</tt> builtin causes fish to add the readline style bindings specified by BINDINGS to the list of key bindings, as if they appeared in your <tt>~/.fish_inputrc</tt> file.
+
+For more information on the syntax keyboard bindings, use <tt>man
+readline</tt> to access the readline documentation. The availiable commands
+are listed in the <a href="index.html#editor">Command Line Editor</a> section
+of the fish manual - but you may also use any fish command! To write such
+commands, see the <a href="#commandline">commandline</a> builtin. It's good
+practice to put the code into a <tt><a href="#function">function</a> -b</tt>
+and bind to the function name.
\subsection bind-description Description
- <tt>-M MODE</tt> or <tt>--set-mode=MODE</tt> sets the current input mode to MODE.
-
\subsection bind-example Example
<tt>bind -M vi</tt> changes to the vi input mode