aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/options.txt7
-rw-r--r--runtime/lua/vim/_meta/options.lua7
2 files changed, 8 insertions, 6 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 53847cf36d..2a8eb50acd 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1276,9 +1276,10 @@ A jump table for the options with a short description can be found at |Q_op|.
The key used in Command-line Mode to open the command-line window.
Only non-printable keys are allowed.
The key can be specified as a single character, but it is difficult to
- type. The preferred way is to use the <> notation. Examples: >vim
- exe "set cedit=\<C-Y>"
- exe "set cedit=\<Esc>"
+ type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
+ a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >vim
+ set cedit=^Y
+ set cedit=<Esc>
< |Nvi| also has this option, but it only uses the first character.
See |cmdwin|.
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 923d279887..76715e1d9b 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -731,11 +731,12 @@ vim.go.cd = vim.go.cdpath
--- The key used in Command-line Mode to open the command-line window.
--- Only non-printable keys are allowed.
--- The key can be specified as a single character, but it is difficult to
---- type. The preferred way is to use the <> notation. Examples:
+--- type. The preferred way is to use `key-notation` (e.g. <Up>, <C-F>) or
+--- a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples:
---
--- ```vim
---- exe "set cedit=\\<C-Y>"
---- exe "set cedit=\\<Esc>"
+--- set cedit=^Y
+--- set cedit=<Esc>
--- ```
--- `Nvi` also has this option, but it only uses the first character.
--- See `cmdwin`.