aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2026-10-17 11:34:02 -0400
committerGitHub <noreply@github.com>2026-10-17 11:34:02 -0400
commit0851e7dabed9fc9c019e22088029f36e9f3ec3e3 (patch)
tree35a1abb6a3d08b49e6a45ad3de089b622e1605ae
parentf8b704e019ed8194a5e873773670b263abd3dedf (diff)
downloadrneovim-master.tar.gz
rneovim-master.tar.bz2
rneovim-master.zip
docs(help): specify h4 "function signature" format #42434master
Work towards enabling ["flow" layout](https://github.com/neovim/neovim/blob/9244da12e400ec0291450a5e9400d995e7a29b83/src/gen/gen_help_html.lua#L86-L88) in all `:help` files. Problem: The final boss of vimdoc pseudo-structure: Vim's quasi-headings on function signatures and excmd docs is visually distinctive but too inconsistent for a nice parse rule. Solution: - Define the quasi-heading format as an "h4" variant, specified at `:help help-tag-heading`. - For simplicity and predictability, it is defined as any line that ends with a help tag(s) preceded by 2 or more spaces (or 1 tab). - Update existing docs. - This one-time update has a lot of changes, but is very unlikely to conflict with ported Vim-patches because (1) Vim rarely adds new *excmds* that we want, and (2) *function* docs are auto-generated. ref https://github.com/neovim/tree-sitter-vimdoc/issues/110
-rw-r--r--runtime/doc/api.txt74
-rw-r--r--runtime/doc/autocmd.txt552
-rw-r--r--runtime/doc/change.txt409
-rw-r--r--runtime/doc/cmdline.txt64
-rw-r--r--runtime/doc/credits.txt2
-rw-r--r--runtime/doc/diagnostic.txt29
-rw-r--r--runtime/doc/diff.txt26
-rw-r--r--runtime/doc/digraph.txt12
-rw-r--r--runtime/doc/editing.txt244
-rw-r--r--runtime/doc/fold.txt104
-rw-r--r--runtime/doc/ft_ada.txt115
-rw-r--r--runtime/doc/gui.txt12
-rw-r--r--runtime/doc/helphelp.txt60
-rw-r--r--runtime/doc/if_perl.txt67
-rw-r--r--runtime/doc/if_pyth.txt19
-rw-r--r--runtime/doc/if_ruby.txt20
-rw-r--r--runtime/doc/insert.txt184
-rw-r--r--runtime/doc/l10n-arabic.txt4
-rw-r--r--runtime/doc/lsp.txt121
-rw-r--r--runtime/doc/lua-async.txt6
-rw-r--r--runtime/doc/lua.txt59
-rw-r--r--runtime/doc/map.txt47
-rw-r--r--runtime/doc/mlang.txt6
-rw-r--r--runtime/doc/motion.txt519
-rw-r--r--runtime/doc/options.txt45
-rw-r--r--runtime/doc/pack.txt4
-rw-r--r--runtime/doc/pattern.txt171
-rw-r--r--runtime/doc/pi_tutor.txt2
-rw-r--r--runtime/doc/plugins.txt2
-rw-r--r--runtime/doc/quickfix.txt329
-rw-r--r--runtime/doc/recover.txt15
-rw-r--r--runtime/doc/repeat.txt80
-rw-r--r--runtime/doc/scroll.txt102
-rw-r--r--runtime/doc/sign.txt3
-rw-r--r--runtime/doc/spell.txt74
-rw-r--r--runtime/doc/starting.txt52
-rw-r--r--runtime/doc/syntax.txt24
-rw-r--r--runtime/doc/tabpage.txt46
-rw-r--r--runtime/doc/tagsrch.txt229
-rw-r--r--runtime/doc/treesitter.txt287
-rw-r--r--runtime/doc/undo.txt41
-rw-r--r--runtime/doc/userfunc.txt10
-rw-r--r--runtime/doc/various.txt152
-rw-r--r--runtime/doc/vimeval.txt89
-rw-r--r--runtime/doc/vimfn.txt20
-rw-r--r--runtime/doc/vimscript.txt30
-rw-r--r--runtime/doc/visual.txt52
-rw-r--r--runtime/doc/vvars.txt308
-rw-r--r--runtime/doc/windows.txt258
-rwxr-xr-xsrc/gen/gen_eval_files.lua58
-rw-r--r--src/gen/gen_help_html.lua56
-rwxr-xr-xsrc/gen/gen_vimdoc.lua35
52 files changed, 2536 insertions, 2793 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index f8a4ceb137..346e815d25 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -1173,8 +1173,7 @@ nvim_input({keys}) *nvim_input()*
(`integer`) Number of bytes actually written (can be fewer than
requested if the buffer becomes full).
- *nvim_input_mouse()*
-nvim_input_mouse({button}, {action}, {modifier}, {grid}, {row}, {col})
+nvim_input_mouse({button}, {action}, {modifier}, {grid}, {row}, {col}) *nvim_input_mouse()*
Send mouse event from GUI.
Non-blocking: does not wait on any result, but queues the event to be
@@ -1403,8 +1402,7 @@ nvim_put({lines}, {type}, {after}, {follow}) *nvim_put()*
before (like |P|).
• {follow} (`boolean`) If true place cursor at end of inserted text.
- *nvim_replace_termcodes()*
-nvim_replace_termcodes({str}, {from_part}, {do_lt}, {special})
+nvim_replace_termcodes({str}, {from_part}, {do_lt}, {special}) *nvim_replace_termcodes()*
Converts terminal codes and |keycodes| (<CR>, <Esc>, …) in a key
sequence, to the internal representation. See also Lua |vim.keycode()|.
@@ -1427,8 +1425,7 @@ nvim_replace_termcodes({str}, {from_part}, {do_lt}, {special})
• replace_termcodes
• cpoptions
- *nvim_select_popupmenu_item()*
-nvim_select_popupmenu_item({item}, {insert}, {finish}, {opts})
+nvim_select_popupmenu_item({item}, {insert}, {finish}, {opts}) *nvim_select_popupmenu_item()*
Selects an item in the completion popup menu.
If neither |ins-completion| nor |cmdline-completion| popup menu is active
@@ -1451,8 +1448,7 @@ nvim_select_popupmenu_item({item}, {insert}, {finish}, {opts})
• {opts} (`vim.api.keyset.empty?`) Optional parameters. Reserved for
future use.
- *nvim_set_client_info()*
-nvim_set_client_info({name}, {version}, {type}, {methods}, {attributes})
+nvim_set_client_info({name}, {version}, {type}, {methods}, {attributes}) *nvim_set_client_info()*
Self-identifies the client, and sets optional flags on the channel.
Defines the `client` object returned by |nvim_get_chan_info()|.
@@ -1905,8 +1901,7 @@ nvim__redraw({opts}) *nvim__redraw()*
See also: ~
• |:redraw|
- *nvim__set_restart_on_crash()*
-nvim__set_restart_on_crash({progpath}, {argv})
+nvim__set_restart_on_crash({progpath}, {argv}) *nvim__set_restart_on_crash()*
WARNING: This feature is experimental/unstable.
@@ -1926,8 +1921,7 @@ nvim__stats() *nvim__stats()*
==============================================================================
Vimscript Functions *api-vimscript*
- *nvim_call_dict_function()*
-nvim_call_dict_function({dict}, {fn}, {args})
+nvim_call_dict_function({dict}, {fn}, {args}) *nvim_call_dict_function()*
Calls a Vimscript |Dictionary-function| with the given arguments.
On execution error: fails with Vimscript error, updates v:errmsg.
@@ -2475,8 +2469,7 @@ nvim_buf_call({buf}, {fn}) *nvim_buf_call()*
Return: ~
(`any`) Value(s) returned by `fn()`.
- *nvim_buf_del_keymap()*
-nvim_buf_del_keymap({buf}, {mode}, {lhs}, {opts})
+nvim_buf_del_keymap({buf}, {mode}, {lhs}, {opts}) *nvim_buf_del_keymap()*
Unmaps a buffer-local |mapping| for the given mode.
Attributes: ~
@@ -2585,8 +2578,7 @@ nvim_buf_get_keymap({buf}, {mode}) *nvim_buf_get_keymap()*
(`vim.api.keyset.get_keymap[]`) Array of |maparg()|-like dictionaries
describing mappings. The "buf" key holds the associated buffer id.
- *nvim_buf_get_lines()*
-nvim_buf_get_lines({buf}, {start}, {end}, {strict_indexing})
+nvim_buf_get_lines({buf}, {start}, {end}, {strict_indexing}) *nvim_buf_get_lines()*
Gets a line-range from the buffer.
Indexing is zero-based, end-exclusive. Negative indices are interpreted as
@@ -2671,9 +2663,7 @@ nvim_buf_get_offset({buf}, {index}) *nvim_buf_get_offset()*
Return: ~
(`integer`) Integer byte offset, or -1 for unloaded buffer.
- *nvim_buf_get_text()*
-nvim_buf_get_text({buf}, {start_row}, {start_col}, {end_row}, {end_col},
- {opts})
+nvim_buf_get_text({buf}, {start_row}, {start_col}, {end_row}, {end_col}, {opts}) *nvim_buf_get_text()*
Gets a range from the buffer (may be partial lines, unlike
|nvim_buf_get_lines()|).
@@ -2752,8 +2742,7 @@ nvim_buf_line_count({buf}) *nvim_buf_line_count()*
Return: ~
(`integer`) Line count, or 0 for unloaded buffer. |api-buffer|
- *nvim_buf_set_keymap()*
-nvim_buf_set_keymap({buf}, {mode}, {lhs}, {rhs}, {opts})
+nvim_buf_set_keymap({buf}, {mode}, {lhs}, {rhs}, {opts}) *nvim_buf_set_keymap()*
Sets a buffer-local |mapping| for the given mode.
Attributes: ~
@@ -2769,8 +2758,7 @@ nvim_buf_set_keymap({buf}, {mode}, {lhs}, {rhs}, {opts})
See also: ~
• |nvim_set_keymap()|
- *nvim_buf_set_lines()*
-nvim_buf_set_lines({buf}, {start}, {end}, {strict_indexing}, {replacement})
+nvim_buf_set_lines({buf}, {start}, {end}, {strict_indexing}, {replacement}) *nvim_buf_set_lines()*
Sets (replaces) a line-range in the buffer.
Indexing is zero-based, end-exclusive. Negative indices are interpreted as
@@ -2798,8 +2786,7 @@ nvim_buf_set_lines({buf}, {start}, {end}, {strict_indexing}, {replacement})
See also: ~
• |nvim_buf_set_text()|
- *nvim_buf_set_mark()*
-nvim_buf_set_mark({buf}, {name}, {line}, {col}, {opts})
+nvim_buf_set_mark({buf}, {name}, {line}, {col}, {opts}) *nvim_buf_set_mark()*
Sets a named mark in the given buffer, all marks are allowed
file/uppercase, visual, last change, etc. See |mark-motions|.
@@ -2836,9 +2823,7 @@ nvim_buf_set_name({buf}, {name}) *nvim_buf_set_name()*
• {buf} (`integer`) Buffer id, or 0 for current buffer
• {name} (`string`) Buffer name
- *nvim_buf_set_text()*
-nvim_buf_set_text({buf}, {start_row}, {start_col}, {end_row}, {end_col},
- {replacement})
+nvim_buf_set_text({buf}, {start_row}, {start_col}, {end_row}, {end_col}, {replacement}) *nvim_buf_set_text()*
Sets (replaces) a range in the buffer
This is recommended over |nvim_buf_set_lines()| when only modifying parts
@@ -2886,8 +2871,7 @@ nvim_buf_set_var({buf}, {name}, {value}) *nvim_buf_set_var()*
==============================================================================
Command Functions *api-command*
- *nvim_buf_create_user_command()*
-nvim_buf_create_user_command({buf}, {name}, {cmd}, {opts})
+nvim_buf_create_user_command({buf}, {name}, {cmd}, {opts}) *nvim_buf_create_user_command()*
Creates a buffer-local command |user-commands|.
Attributes: ~
@@ -2969,8 +2953,7 @@ nvim_cmd({cmd}, {opts}) *nvim_cmd()*
• |nvim_exec2()|
• |nvim_parse_cmd()|
- *nvim_create_user_command()*
-nvim_create_user_command({name}, {cmd}, {opts})
+nvim_create_user_command({name}, {cmd}, {opts}) *nvim_create_user_command()*
Creates a global |user-commands| command.
For Lua usage see |lua-guide-commands-create|.
@@ -3127,8 +3110,7 @@ nvim_parse_cmd({str}, {opts}) *nvim_parse_cmd()*
==============================================================================
Extmark Functions *api-extmark*
- *nvim_buf_clear_namespace()*
-nvim_buf_clear_namespace({buf}, {ns_id}, {line_start}, {line_end})
+nvim_buf_clear_namespace({buf}, {ns_id}, {line_start}, {line_end}) *nvim_buf_clear_namespace()*
Clears |namespace|d objects (highlights, |extmarks|, virtual text) from a
region.
@@ -3160,8 +3142,7 @@ nvim_buf_del_extmark({buf}, {ns_id}, {id}) *nvim_buf_del_extmark()*
Return: ~
(`boolean`) true if the extmark was found, else false
- *nvim_buf_get_extmark_by_id()*
-nvim_buf_get_extmark_by_id({buf}, {ns_id}, {id}, {opts})
+nvim_buf_get_extmark_by_id({buf}, {ns_id}, {id}, {opts}) *nvim_buf_get_extmark_by_id()*
Gets the position (0-indexed) of an |extmark|.
Attributes: ~
@@ -3187,8 +3168,7 @@ nvim_buf_get_extmark_by_id({buf}, {ns_id}, {id}, {opts})
the entirety of text span range is deleted. See also the key
`invalidate` in |nvim_buf_set_extmark()|.
- *nvim_buf_get_extmarks()*
-nvim_buf_get_extmarks({buf}, {ns_id}, {start}, {end}, {opts})
+nvim_buf_get_extmarks({buf}, {ns_id}, {start}, {end}, {opts}) *nvim_buf_get_extmarks()*
Gets |extmarks| in "traversal order" from a |charwise| region defined by
buffer positions (inclusive, 0-indexed |api-indexing|).
@@ -3253,8 +3233,7 @@ nvim_buf_get_extmarks({buf}, {ns_id}, {start}, {end}, {opts})
`[extmark_id, row, col, details?]` tuples in "traversal order". For
the `details` dictionary, see |nvim_buf_get_extmark_by_id()|.
- *nvim_buf_set_extmark()*
-nvim_buf_set_extmark({buf}, {ns_id}, {line}, {col}, {opts})
+nvim_buf_set_extmark({buf}, {ns_id}, {line}, {col}, {opts}) *nvim_buf_set_extmark()*
Creates or updates an |extmark|.
By default a new extmark is created when no id is passed in, but it is
@@ -3436,8 +3415,7 @@ nvim_get_namespaces() *nvim_get_namespaces()*
Return: ~
(`table<string,integer>`) dict that maps from names to namespace ids.
- *nvim_set_decoration_provider()*
-nvim_set_decoration_provider({ns_id}, {opts})
+nvim_set_decoration_provider({ns_id}, {opts}) *nvim_set_decoration_provider()*
Set or change decoration provider for a |namespace|
This is a very general purpose interface for having Lua callbacks being
@@ -3614,8 +3592,7 @@ nvim_get_option_value({name}, {opts}) *nvim_get_option_value()*
Return: ~
(`any`) Option value
- *nvim_set_option_value()*
-nvim_set_option_value({name}, {value}, {opts})
+nvim_set_option_value({name}, {value}, {opts}) *nvim_set_option_value()*
Sets the value of an option. The behavior of this function matches that of
|:set|: for global-local options, both the global and local value are set
unless otherwise specified with {scope}.
@@ -3744,8 +3721,7 @@ nvim_tabpage_list_wins({tabpage}) *nvim_tabpage_list_wins()*
Return: ~
(`integer[]`) List of windows in `tabpage`
- *nvim_tabpage_set_var()*
-nvim_tabpage_set_var({tabpage}, {name}, {value})
+nvim_tabpage_set_var({tabpage}, {name}, {value}) *nvim_tabpage_set_var()*
Sets a tab-scoped (t:) variable
Attributes: ~
@@ -3800,8 +3776,7 @@ nvim_ui_detach() *nvim_ui_detach()*
|RPC| only
Since: 0.1.0
- *nvim_ui_pum_set_bounds()*
-nvim_ui_pum_set_bounds({width}, {height}, {row}, {col})
+nvim_ui_pum_set_bounds({width}, {height}, {row}, {col}) *nvim_ui_pum_set_bounds()*
Tells Nvim the geometry of the popupmenu, to align floating windows with
an external popup menu.
@@ -3878,8 +3853,7 @@ nvim_ui_try_resize({width}, {height}) *nvim_ui_try_resize()*
• {width} (`integer`)
• {height} (`integer`)
- *nvim_ui_try_resize_grid()*
-nvim_ui_try_resize_grid({grid}, {width}, {height})
+nvim_ui_try_resize_grid({grid}, {width}, {height}) *nvim_ui_try_resize_grid()*
Tell Nvim to resize a grid. Triggers a grid_resize event with the
requested grid size or the maximum size if it exceeds size limits.
diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt
index 10ea533f87..b7cd705270 100644
--- a/runtime/doc/autocmd.txt
+++ b/runtime/doc/autocmd.txt
@@ -43,8 +43,7 @@ Use |nvim_create_autocmd()| to define an event handler from Lua.
Vimscript commands are described below.
- *:au* *:autocmd*
-:au[tocmd] [group] {event} {aupat} [++once] [++nested] {cmd}
+:au[tocmd] [group] {event} {aupat} [++once] [++nested] {cmd} *:au* *:autocmd*
Add {cmd} to the list of commands that Vim will
execute automatically on {event} for a file matching
{aupat} |autocmd-pattern|.
@@ -242,8 +241,8 @@ enabled, you can annotate your handler to get type-checking and completion: >lua
*events* *{event}*
Nvim recognizes the following events. Names are case-insensitive.
- *BufAdd*
-BufAdd After adding a new buffer or existing unlisted
+BufAdd *BufAdd*
+ After adding a new buffer or existing unlisted
buffer to the buffer list (except during
startup, see |VimEnter|), or renaming a listed
buffer.
@@ -251,8 +250,8 @@ BufAdd After adding a new buffer or existing unlisted
NOTE: Current buffer "%" is not the target
buffer "<afile>", "<abuf>". |<buffer=abuf>|
- *BufDelete*
-BufDelete Before deleting a buffer from the buffer list.
+BufDelete *BufDelete*
+ Before deleting a buffer from the buffer list.
The BufUnload may be called first (if the
buffer was loaded).
Also used just before a buffer in the buffer
@@ -261,24 +260,24 @@ BufDelete Before deleting a buffer from the buffer list.
buffer "<afile>", "<abuf>". |<buffer=abuf>|
Do not change to another buffer.
- *BufEnter*
-BufEnter After entering (visiting, switching-to) a new
+BufEnter *BufEnter*
+ After entering (visiting, switching-to) a new
or existing buffer. Useful for setting
filetype options. Compare |BufNew| which
does not trigger for existing buffers.
After |BufAdd|.
After |BufReadPost|.
- *BufFilePost*
-BufFilePost After changing the name of the current buffer
+BufFilePost *BufFilePost*
+ After changing the name of the current buffer
with the ":file" or ":saveas" command.
- *BufFilePre*
-BufFilePre Before changing the name of the current buffer
+BufFilePre *BufFilePre*
+ Before changing the name of the current buffer
with the ":file" or ":saveas" command.
- *BufHidden*
-BufHidden Before a buffer becomes hidden: when there are
+BufHidden *BufHidden*
+ Before a buffer becomes hidden: when there are
no longer windows that show the buffer, but
the buffer is not unloaded or deleted.
@@ -286,15 +285,15 @@ BufHidden Before a buffer becomes hidden: when there are
NOTE: Current buffer "%" is not the target
buffer "<afile>", "<abuf>". |<buffer=abuf>|
- *BufLeave*
-BufLeave Before leaving to another buffer. Also when
+BufLeave *BufLeave*
+ Before leaving to another buffer. Also when
leaving or closing the current window and the
new current window is not for the same buffer.
Not used for ":qa" or ":q" when exiting Vim.
- *BufNew*
-BufNew After creating a new buffer (except during
+BufNew *BufNew*
+ After creating a new buffer (except during
startup, see |VimEnter|) or renaming an
existing buffer. Unlike |BufEnter|, visiting
(switching to) an existing buffer will not
@@ -303,13 +302,13 @@ BufNew After creating a new buffer (except during
buffer "<afile>", "<abuf>". |<buffer=abuf>|
See also |BufAdd|, |BufNewFile|.
- *BufNewFile*
-BufNewFile When starting to edit a file that doesn't
+BufNewFile *BufNewFile*
+ When starting to edit a file that doesn't
exist. Can be used to read in a skeleton
file.
- *BufRead* *BufReadPost*
-BufRead or BufReadPost When starting to edit a new buffer, after
+BufRead or BufReadPost *BufRead* *BufReadPost*
+ When starting to edit a new buffer, after
reading the file into the buffer, before
processing modelines. See |BufWinEnter| to do
something after processing modelines.
@@ -323,17 +322,17 @@ BufRead or BufReadPost When starting to edit a new buffer, after
- for the `:read file` command
- when the file doesn't exist
- *BufReadCmd*
-BufReadCmd Before starting to edit a new buffer. Should
+BufReadCmd *BufReadCmd*
+ Before starting to edit a new buffer. Should
read the file into the buffer. |Cmd-event|
- *BufReadPre* *E200* *E201*
-BufReadPre When starting to edit a new buffer, before
+BufReadPre *BufReadPre* *E200* *E201*
+ When starting to edit a new buffer, before
reading the file into the buffer. Not used
if the file doesn't exist.
- *BufUnload*
-BufUnload Before unloading a buffer, when the text in
+BufUnload *BufUnload*
+ Before unloading a buffer, when the text in
the buffer is going to be freed.
After BufWritePost.
Before BufDelete.
@@ -346,8 +345,8 @@ BufUnload Before unloading a buffer, when the text in
Not triggered when exiting and v:dying is 2 or
more.
- *BufWinEnter*
-BufWinEnter After a buffer is displayed in a window. This
+BufWinEnter *BufWinEnter*
+ After a buffer is displayed in a window. This
may be when the buffer is loaded (after
processing modelines) or when a hidden buffer
is displayed (and is no longer hidden).
@@ -358,8 +357,8 @@ BufWinEnter After a buffer is displayed in a window. This
Triggered for ":split" with the name of the
current buffer, since it reloads that buffer.
- *BufWinLeave*
-BufWinLeave Before a buffer is removed from a window.
+BufWinLeave *BufWinLeave*
+ Before a buffer is removed from a window.
Not when it's still visible in another window.
Also triggered when exiting.
Before BufUnload, BufHidden.
@@ -368,8 +367,8 @@ BufWinLeave Before a buffer is removed from a window.
Not triggered when exiting and v:dying is 2 or
more.
- *BufWipeout*
-BufWipeout Before completely deleting a buffer. The
+BufWipeout *BufWipeout*
+ Before completely deleting a buffer. The
BufUnload and BufDelete events may be called
first (if the buffer was loaded and was in the
buffer list). Also used just before a buffer
@@ -379,11 +378,11 @@ BufWipeout Before completely deleting a buffer. The
buffer "<afile>", "<abuf>". |<buffer=abuf>|
Do not change to another buffer.
- *BufWrite* *BufWritePre*
-BufWrite or BufWritePre Before writing the whole buffer to a file.
+BufWrite or BufWritePre *BufWrite* *BufWritePre*
+ Before writing the whole buffer to a file.
- *BufWriteCmd*
-BufWriteCmd Before writing the whole buffer to a file.
+BufWriteCmd *BufWriteCmd*
+ Before writing the whole buffer to a file.
Should do the writing of the file and reset
'modified' if successful, unless '+' is in
'cpo' and writing to another file |cpo-+|.
@@ -394,34 +393,34 @@ BufWriteCmd Before writing the whole buffer to a file.
the |'[| and |']| marks for the range of lines.
|Cmd-event|
- *BufWritePost*
-BufWritePost After writing the whole buffer to a file
+BufWritePost *BufWritePost*
+ After writing the whole buffer to a file
(should undo the commands for BufWritePre).
- *ChanClose*
-ChanClose After a channel was closed, before it is removed.
+ChanClose *ChanClose*
+ After a channel was closed, before it is removed.
This is triggered even when inside an
autocommand defined without |autocmd-nested|.
Sets these |v:event| keys:
info as from |nvim_get_chan_info()|
- *ChanInfo*
-ChanInfo State of channel changed, for instance the
+ChanInfo *ChanInfo*
+ State of channel changed, for instance the
client of a RPC channel described itself.
This is triggered even when inside an
autocommand defined without |autocmd-nested|.
Sets these |v:event| keys:
info as from |nvim_get_chan_info()|
- *ChanOpen*
-ChanOpen Just after a channel was opened.
+ChanOpen *ChanOpen*
+ Just after a channel was opened.
This is triggered even when inside an
autocommand defined without |autocmd-nested|.
Sets these |v:event| keys:
info as from |nvim_get_chan_info()|
- *CmdAtom*
-CmdAtom After a user action (an "atom" of input): any
+CmdAtom *CmdAtom*
+ After a user action (an "atom" of input): any
normal command, motion, operator, insert
session, Visual sequence, Ex cmdline
(":cnext<CR>"), mapping (and subatoms), macro,
@@ -510,15 +509,15 @@ CmdAtom After a user action (an "atom" of input): any
- undoseq: Undo state after the action
(|undotree()| `seq_cur`). Decreases on undo.
- *CmdlineChanged*
-CmdlineChanged After EVERY change inside command line. Also
+CmdlineChanged *CmdlineChanged*
+ After EVERY change inside command line. Also
triggered during mappings! Use |<Cmd>| instead
of ":" in mappings, to avoid that.
<afile> expands to the |cmdline-char|.
- *CmdlineEnter*
-CmdlineEnter After entering the command-line (including
+CmdlineEnter *CmdlineEnter*
+ After entering the command-line (including
non-interactive use of ":" in a mapping: use
|<Cmd>| instead to avoid this).
The pattern is matched against |cmdline-char|.
@@ -527,8 +526,8 @@ CmdlineEnter After entering the command-line (including
cmdlevel
cmdtype
- *CmdlineLeave*
-CmdlineLeave Before leaving the command-line (including
+CmdlineLeave *CmdlineLeave*
+ Before leaving the command-line (including
non-interactive use of ":" in a mapping: use
|<Cmd>| instead to avoid this).
<afile> expands to the |cmdline-char|.
@@ -542,8 +541,8 @@ CmdlineLeave Before leaving the command-line (including
to true: cannot execute an already aborted
cmdline by changing it to false.
- *CmdlineLeavePre*
-CmdlineLeavePre Just before leaving the command line, and
+CmdlineLeavePre *CmdlineLeavePre*
+ Just before leaving the command line, and
before |CmdlineLeave|. Useful for capturing
completion info with |cmdcomplete_info()|, as
this information is cleared before
@@ -554,8 +553,8 @@ CmdlineLeavePre Just before leaving the command line, and
or <Esc>. <afile> is set to |cmdline-char|.
Sets |v:char| as with |CmdlineLeave|.
- *CmdUndefined*
-CmdUndefined When a user command is used but it isn't
+CmdUndefined *CmdUndefined*
+ When a user command is used but it isn't
defined. Useful for defining a command only
when it's used. The pattern is matched
against the command name. Both <amatch> and
@@ -567,24 +566,24 @@ CmdUndefined When a user command is used but it isn't
always define the user command and have it
invoke an autoloaded function. See |autoload|.
- *CmdwinEnter*
-CmdwinEnter After entering the command-line window.
+CmdwinEnter *CmdwinEnter*
+ After entering the command-line window.
Useful for setting options specifically for
this special type of window.
<afile> expands to a single character,
indicating the type of command-line.
|cmdwin-char|
- *CmdwinLeave*
-CmdwinLeave Before leaving the command-line window.
+CmdwinLeave *CmdwinLeave*
+ Before leaving the command-line window.
Useful to clean up any global setting done
with CmdwinEnter.
<afile> expands to a single character,
indicating the type of command-line.
|cmdwin-char|
- *ColorScheme*
-ColorScheme After loading a color scheme. |:colorscheme|
+ColorScheme *ColorScheme*
+ After loading a color scheme. |:colorscheme|
Not triggered if the color scheme is not
found.
The pattern is matched against the
@@ -593,8 +592,8 @@ ColorScheme After loading a color scheme. |:colorscheme|
set, and <amatch> for the new colorscheme
name.
- *ColorSchemePre*
-ColorSchemePre Before loading a color scheme. |:colorscheme|
+ColorSchemePre *ColorSchemePre*
+ Before loading a color scheme. |:colorscheme|
Useful to setup removing things added by a
color scheme, before another one is loaded.
@@ -621,8 +620,8 @@ CompleteChanged *CompleteChanged*
The size and position of the popup are also
available by calling |pum_getpos()|.
- *CompleteDone*
-CompleteDone After Insert mode co