summaryrefslogtreecommitdiffstats
path: root/runtime/doc/cmdline.txt
diff options
context:
space:
mode:
authorYee Cheng Chin <ychin.git@gmail.com>2023-10-14 02:23:45 -0700
committerGitHub <noreply@github.com>2023-10-14 11:23:45 +0200
commit2bbd0d30eebdea66c0da3895e83d999ed6ad83fb (patch)
tree8bb6c2bfeb49553e2295643812180e148a4090f7 /runtime/doc/cmdline.txt
parent29bb67f1beefc7fd393dbfd9ee77d92f1db3a3c0 (diff)
runtime(doc): Improve command-line completion docs (#13331)
* Improve command-line completion docs Add more details about 'ignorecase' and its effect on cmdline completion. Make sure keys used in wildmenu are properly documented and linked in the keys' documentation entries, and in `:h index` for proper cross-referencing, as wildmenu popup is slightly different from insert-mode popup menu. * Fix docs typos Signed-off-by: Christian Brabandt <cb@256bit.org>
Diffstat (limited to 'runtime/doc/cmdline.txt')
-rw-r--r--runtime/doc/cmdline.txt25
1 files changed, 18 insertions, 7 deletions
diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt
index 9493658ed5..6d58d63873 100644
--- a/runtime/doc/cmdline.txt
+++ b/runtime/doc/cmdline.txt
@@ -90,9 +90,11 @@ CTRL-SHIFT-Q Works just like CTRL-V, unless |modifyOtherKeys| is active,
In the GUI the |key-notation| is inserted without simplifying.
*c_<Left>* *c_Left*
-<Left> cursor left
+<Left> cursor left. See 'wildmenu' for behavior during wildmenu
+ completion mode.
*c_<Right>* *c_Right*
-<Right> cursor right
+<Right> cursor right. See 'wildmenu' for behavior during wildmenu
+ completion mode.
*c_<S-Left>*
<S-Left> or <C-Left> *c_<C-Left>*
cursor one WORD left
@@ -102,7 +104,8 @@ CTRL-SHIFT-Q Works just like CTRL-V, unless |modifyOtherKeys| is active,
CTRL-B or <Home> *c_CTRL-B* *c_<Home>* *c_Home*
cursor to beginning of command-line
CTRL-E or <End> *c_CTRL-E* *c_<End>* *c_End*
- cursor to end of command-line
+ cursor to end of command-line. See 'wildmenu' for behavior
+ during wildmenu completion mode.
*c_<LeftMouse>*
<LeftMouse> Move the cursor to the position of the mouse click.
@@ -237,6 +240,7 @@ CTRL-\ e {expr} *c_CTRL-\_e*
CTRL-Y When there is a modeless selection, copy the selection into
the clipboard. |modeless-selection|
If there is no selection CTRL-Y is inserted as a character.
+ See 'wildmenu' for behavior during wildmenu completion mode.
CTRL-M or CTRL-J *c_CTRL-M* *c_CTRL-J* *c_<NL>* *c_<CR>* *c_CR*
<CR> or <NL> start entered command
@@ -252,12 +256,14 @@ CTRL-C quit command-line without executing
*c_<Up>* *c_Up*
<Up> recall older command-line from history, whose beginning
- matches the current command-line (see below).
+ matches the current command-line (see below). See 'wildmenu'
+ for behavior during wildmenu completion mode.
{not available when compiled without the |+cmdline_hist|
feature}
*c_<Down>* *c_Down*
<Down> recall more recent command-line from history, whose beginning
- matches the current command-line (see below).
+ matches the current command-line (see below). See 'wildmenu'
+ for behavior during wildmenu completion mode.
{not available when compiled without the |+cmdline_hist|
feature}
@@ -463,11 +469,16 @@ When repeating 'wildchar' or CTRL-N you cycle through the matches, eventually
ending up back to what was typed. If the first match is not what you wanted,
you can use <S-Tab> or CTRL-P to go straight back to what you typed.
-The 'wildignorecase' option can be set to ignore case in filenames.
-
The 'wildmenu' option can be set to show the matches just above the command
line.
+The 'wildoptions' option provides additional configuration to use a popup menu
+for 'wildmenu', and to use fuzzy matching.
+
+The 'wildignorecase' option can be set to ignore case in filenames. For
+completing other texts (e.g. command names), the 'ignorecase' option is used
+instead (fuzzy matching always ignores case, however).
+
If you like tcsh's autolist completion, you can use this mapping:
:cnoremap X <C-L><C-D>
(Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)