aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src
diff options
context:
space:
mode:
authorGravatar ridiculousfish <corydoras@ridiculousfish.com>2013-09-30 11:45:29 -0700
committerGravatar ridiculousfish <corydoras@ridiculousfish.com>2013-09-30 11:45:54 -0700
commit6c70ed79ae523ea730ba29ff2e84da41a6b5e230 (patch)
tree3d6d30a7a12014c1063a7c03a05ce733b983d486 /doc_src
parent488652c23a2d0cdaf3eaef96e6db22bb1162e2ca (diff)
Update docs to describe autosuggestions. Fixes #937
Diffstat (limited to 'doc_src')
-rw-r--r--doc_src/index.hdr.in14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc_src/index.hdr.in b/doc_src/index.hdr.in
index 5886340d..25fcac64 100644
--- a/doc_src/index.hdr.in
+++ b/doc_src/index.hdr.in
@@ -376,6 +376,20 @@ Help on a specific builtin can also be obtained with the <code>-h</code>
parameter. For instance, to obtain help on the \c fg builtin, either
type <code>fg -h</code> or <code>help fg</code>.
+\section autosuggestions Autosuggestions
+
+fish suggests commands as you type, based on command history, completions,
+and valid file paths. As you type commands, you will see a completion offered after the
+cursor, in a muted gray color (which can be changed with the
+<code>fish_color_autosuggestion</code> variable).
+
+To accept the autosuggestion (replacing the command line contents),
+hit right arrow or Control-F. If the autosuggestion is not what you want,
+just ignore it: it won't execute unless you accept it.
+
+Autosuggestions are a powerful way to quickly summon frequently entered commands, by
+typing the first few characters. They are also an efficient technique for navigating
+through directory hierarchies.
\section completion Tab completion