docs: format vim_diff.txt for "flow" layout #28584

runtime/doc/vim_diff.txt

@@ -1,19 +1,19 @@
 *vim_diff.txt*    Nvim
 
 
-			    NVIM REFERENCE MANUAL
+                            NVIM REFERENCE MANUAL
 
 
-Differences between Nvim and Vim			       *vim-differences*
+Differences between Nvim and Vim                               *vim-differences*
 
 Nvim differs from Vim in many ways, although editor and Vimscript (not
 Vim9script) features are mostly identical.  This document is a complete and
 centralized reference of the differences.
 
-				      Type |gO| to see the table of contents.
+                                      Type |gO| to see the table of contents.
 
 ==============================================================================
-Configuration						    *nvim-config*
+Configuration                                               *nvim-config*
 
 User configuration and data files are found in standard |base-directories|
 (see also |$NVIM_APPNAME|).  Note in particular:
@@ -24,7 +24,7 @@ User configuration and data files are found in standard |base-directories|
   session information.  |shada|
 
 ==============================================================================
-Defaults					            *nvim-defaults*
+Defaults                                                    *nvim-defaults*
 
 - Filetype detection is enabled by default. This can be disabled by adding
   ":filetype off" to |init.vim|.
@@ -99,7 +99,7 @@ Defaults					            *nvim-defaults*
 - |g:vimsyn_embed| defaults to "l" to enable Lua highlighting
 
 DEFAULT MOUSE
-						*default-mouse* *disable-mouse*
+                                                *default-mouse* *disable-mouse*
 By default the mouse is enabled, and <RightMouse> opens a |popup-menu| with
 standard actions ("Cut", "Copy", "Paste", …). Mouse is NOT enabled in
 |command-mode| or the |more-prompt|, so you can temporarily disable it just by
@@ -123,7 +123,7 @@ To remove the "How-to disable mouse" menu item and the separator above it: >vim
   aunmenu PopUp.-1-
 <
 DEFAULT MAPPINGS
-							*default-mappings*
+                                                        *default-mappings*
 Nvim creates the following default mappings at |startup|. You can disable any
 of these in your config by simply removing the mapping, e.g. ":unmap Y".
 
@@ -151,7 +151,7 @@ of these in your config by simply removing the mapping, e.g. ":unmap Y".
   - K |K-lsp-default|
 
 DEFAULT AUTOCOMMANDS
-							*default-autocmds*
+                                                        *default-autocmds*
 Default autocommands exist in the following groups. Use ":autocmd! {group}" to
 remove them and ":autocmd {group}" to see how they're defined.
 
@@ -175,7 +175,7 @@ nvim_swapfile:
   swapfile…" message.
 
 ==============================================================================
-New Features						       *nvim-features*
+New Features                                                   *nvim-features*
 
 MAJOR COMPONENTS
 
@@ -200,7 +200,7 @@ USER EXPERIENCE
 
 Working intuitively and consistently is a major goal of Nvim.
 
-							*feature-compile*
+                                                        *feature-compile*
 - Nvim always includes ALL features, in contrast to Vim (which ships various
   combinations of 100+ optional features).  |feature-compile| Think of it as
   a leaner version of Vim's "HUGE" build. This reduces surface area for bugs,
@@ -247,74 +247,72 @@ by Nvim developers.
 FEATURES
 
 Command-line:
-  The expression prompt (|@=|, |c_CTRL-R_=|, |i_CTRL-R_=|) is highlighted
+- The expression prompt (|@=|, |c_CTRL-R_=|, |i_CTRL-R_=|) is highlighted
   using a built-in Vimscript expression parser. |expr-highlight|
-					*E5408* *E5409*
+- *E5408* *E5409* |input()|, |inputdialog()| support custom highlighting.
-  |input()|, |inputdialog()| support custom highlighting. |input()-highlight|
+  |input()-highlight|
-					*g:Nvim_color_cmdline*
+- (Experimental) *g:Nvim_color_cmdline* Command-line (|:|) is colored by
-  (Experimental) Command-line (|:|) is colored by callback defined in
+  callback defined in `g:Nvim_color_cmdline` (this callback is for testing
-  `g:Nvim_color_cmdline` (this callback is for testing only, and will be
+  only, and will be removed in the future).
-  removed in the future).
 
 Commands:
-  |:checkhealth|
+- |:checkhealth|
-  |:drop| is always available
+- |:drop| is always available
-  |:Man| is available by default, with many improvements such as completion
+- |:Man| is available by default, with many improvements such as completion
-  |:match| can be invoked before highlight group is defined
+- |:match| can be invoked before highlight group is defined
-  |:source| works with Lua
+- |:source| works with Lua
   User commands can support |:command-preview| to show results as you type
-  |:write| with "++p" flag creates parent directories.
+- |:write| with "++p" flag creates parent directories.
 
 Events:
-  |RecordingEnter|
+- |RecordingEnter|
-  |RecordingLeave|
+- |RecordingLeave|
-  |SearchWrapped|
+- |SearchWrapped|
-  |Signal|
+- |Signal|
-  |TabNewEntered|
+- |TabNewEntered|
-  |TermClose|
+- |TermClose|
-  |TermOpen|
+- |TermOpen|
-  |UIEnter|
+- |UIEnter|
-  |UILeave|
+- |UILeave|
 
 Functions:
-  |dictwatcheradd()| notifies a callback whenever a |Dict| is modified
+- |dictwatcheradd()| notifies a callback whenever a |Dict| is modified
-  |dictwatcherdel()|
+- |dictwatcherdel()|
-  |menu_get()|
+- |menu_get()|
-  |msgpackdump()|, |msgpackparse()| provide msgpack de/serialization
+- |msgpackdump()|, |msgpackparse()| provide msgpack de/serialization
-  |stdpath()|
+- |stdpath()|
-  |system()|, |systemlist()| can run {cmd} directly (without 'shell')
+- |system()|, |systemlist()| can run {cmd} directly (without 'shell')
-  |matchadd()| can be called before highlight group is defined
+- |matchadd()| can be called before highlight group is defined
-  |tempname()| tries to recover if the Nvim |tempdir| disappears.
+- |tempname()| tries to recover if the Nvim |tempdir| disappears.
-  |writefile()| with "p" flag creates parent directories.
+- |writefile()| with "p" flag creates parent directories.
 
 Highlight groups:
-  |highlight-blend| controls blend level for a highlight group
+- |highlight-blend| controls blend level for a highlight group
-  |expr-highlight| highlight groups (prefixed with "Nvim")
+- |expr-highlight| highlight groups (prefixed with "Nvim")
-  |hl-NormalFloat| highlights floating window
+- |hl-NormalFloat| highlights floating window
-  |hl-FloatBorder| highlights border of a floating window
+- |hl-FloatBorder| highlights border of a floating window
-  |hl-FloatTitle| highlights title of a floating window
+- |hl-FloatTitle| highlights title of a floating window
-  |hl-FloatFooter| highlights footer of a floating window
+- |hl-FloatFooter| highlights footer of a floating window
-  |hl-NormalNC| highlights non-current windows
+- |hl-NormalNC| highlights non-current windows
-  |hl-MsgArea| highlights messages/cmdline area
+- |hl-MsgArea| highlights messages/cmdline area
-  |hl-MsgSeparator| highlights separator for scrolled messages
+- |hl-MsgSeparator| highlights separator for scrolled messages
-  |hl-Substitute|
+- |hl-Substitute|
-  |hl-TermCursor|
+- |hl-TermCursor|
-  |hl-TermCursorNC|
+- |hl-TermCursorNC|
-  |hl-WinSeparator| highlights window separators
+- |hl-WinSeparator| highlights window separators
-  |hl-Whitespace| highlights 'listchars' whitespace
+- |hl-Whitespace| highlights 'listchars' whitespace
-  |hl-WinBar| highlights 'winbar'
+- |hl-WinBar| highlights 'winbar'
-  |hl-WinBarNC| highlights non-current window 'winbar'
+- |hl-WinBarNC| highlights non-current window 'winbar'
 
 Input/Mappings:
-  ALT (|META|) chords always work (even in the |TUI|). Map |<M-| with any key:
+- ALT (|META|) chords always work (even in the |TUI|). Map |<M-| with any key:
   <M-1>, <M-BS>, <M-Del>, <M-Ins>, <M-/>, <M-\>, <M-Space>, <M-Enter>, etc.
-  Case-sensitive: <M-a> and <M-A> are two different keycodes.
+  - Case-sensitive: <M-a> and <M-A> are two different keycodes.
-
+- ALT may behave like <Esc> if not mapped. |i_ALT| |v_ALT| |c_ALT|
-  ALT may behave like <Esc> if not mapped. |i_ALT| |v_ALT| |c_ALT|
 
 Normal commands:
-  |gO| shows a filetype-defined "outline" of the current buffer.
+- |gO| shows a filetype-defined "outline" of the current buffer.
-  |Q| replays the last recorded macro instead of switching to Ex mode (|gQ|).
+- |Q| replays the last recorded macro instead of switching to Ex mode (|gQ|).
 
 Options:
 
@@ -352,80 +350,73 @@ string options work.
 - 'winhighlight' window-local highlights
 
 Providers:
-  If a Python interpreter is available on your `$PATH`, |:python| and
+- If a Python interpreter is available on your `$PATH`, |:python| and
   |:python3| are always available. See |provider-python|.
 
 Shell:
-  Shell output (|:!|, |:make|, …) is always routed through the UI, so it
+- Shell output (|:!|, |:make|, …) is always routed through the UI, so it
   cannot "mess up" the screen. (You can still use "chansend(v:stderr,…)" if
   you want to mess up the screen :)
-
+- Nvim throttles (skips) messages from shell commands (|:!|, |:grep|, |:make|)
-  Nvim throttles (skips) messages from shell commands (|:!|, |:grep|, |:make|)
   if there is too much output. No data is lost, this only affects display and
   improves performance. |:terminal| output is never throttled.
-
+- |:!| does not support "interactive" commands. Use |:terminal| instead.
-  |:!| does not support "interactive" commands. Use |:terminal| instead.
   (GUI Vim has a similar limitation, see ":help gui-pty" in Vim.)
-
+- :!start is not special-cased on Windows.
-  :!start is not special-cased on Windows.
+- |system()| does not support writing/reading "backgrounded" commands. |E5677|
-
-  |system()| does not support writing/reading "backgrounded" commands. |E5677|
 
 Signs:
-  Signs are removed if the associated line is deleted.
+- Signs are removed if the associated line is deleted.
-  Signs placed twice with the same identifier in the same group are moved.
+- Signs placed twice with the same identifier in the same group are moved.
 
 Startup:
-  |-e| and |-es| invoke the same "improved Ex mode" as -E and -Es.
+- |-e| and |-es| invoke the same "improved Ex mode" as -E and -Es.
-  |-E| and |-Es| read stdin as text (into buffer 1).
+- |-E| and |-Es| read stdin as text (into buffer 1).
-  |-es| and |-Es| have improved behavior:
+- |-es| and |-Es| have improved behavior:
     - Quits automatically, don't need "-c qa!".
     - Skips swap-file dialog.
-  |-s| reads Normal commands from stdin if the script name is "-".
+- |-s| reads Normal commands from stdin if the script name is "-".
-  Reading text (instead of commands) from stdin |--|:
+- Reading text (instead of commands) from stdin |--|:
     - works by default: "-" file is optional
     - works in more cases: |-Es|, file args
 
 TUI:
-			*:set-termcap*
+                        *:set-termcap*
-  Start Nvim with 'verbose' level 3 to show terminal capabilities: >
+- Start Nvim with 'verbose' level 3 to show terminal capabilities: >
-	nvim -V3
+        nvim -V3
 <
-			*'term'* *E529* *E530* *E531*
+                        *'term'* *E529* *E530* *E531*
-  'term' reflects the terminal type derived from |$TERM| and other environment
+- 'term' reflects the terminal type derived from |$TERM| and other environment
   checks.  For debugging only; not reliable during startup. >vim
-	  :echo &term
+          :echo &term
-<  "builtin_x" means one of the |builtin-terms| was chosen, because the expected
+-  "builtin_x" means one of the |builtin-terms| was chosen, because the expected
   terminfo file was not found on the system.
-
+- Nvim will use 256-colour capability on Linux virtual terminals.  Vim uses
-  Nvim will use 256-colour capability on Linux virtual terminals.  Vim uses
   only 8 colours plus bright foreground on Linux VTs.
-
+- Vim combines what is in its |builtin-terms| with what it reads from terminfo,
-  Vim combines what is in its |builtin-terms| with what it reads from terminfo,
   and has a 'ttybuiltin' setting to control how that combination works.  Nvim
   uses one or the other, it does not attempt to merge the two.
 
 UI/Display:
-  |Visual| selection highlights the character at cursor. |visual-use|
+- |Visual| selection highlights the character at cursor. |visual-use|
-
+- messages: When showing messages longer than 'cmdheight', only
-  messages: When showing messages longer than 'cmdheight', only
   scroll the message lines, not the entire screen. The
   separator line is decorated by |hl-MsgSeparator| and
   the "msgsep" flag of 'fillchars'. *msgsep*
 
 Variables:
-  |v:progpath| is always absolute ("full")
+- |v:progpath| is always absolute ("full")
-  |v:windowid| is always available (for use by external UIs)
+- |v:windowid| is always available (for use by external UIs)
-  |OptionSet| autocommand args |v:option_new|, |v:option_old|,
+- |OptionSet| autocommand args |v:option_new|, |v:option_old|,
-  |v:option_oldlocal|, |v:option_oldglobal| have the type of the option
+- |v:option_oldlocal|, |v:option_oldglobal| have the type of the option
   instead of always being strings. |v:option_old| is now the old global value
   for all global-local options, instead of just string global-local options.
 
 Vimscript:
-  |:redir| nested in |execute()| works.
+- |:redir| nested in |execute()| works.
 
 ==============================================================================
-Upstreamed features					 *nvim-upstreamed*
+Upstreamed features                                      *nvim-upstreamed*
 
 These Nvim features were later integrated into Vim.
 
@@ -440,45 +431,44 @@ These Nvim features were later integrated into Vim.
 - 'statusline' supports unlimited alignment sections
 
 ==============================================================================
-Other changes						 *nvim-changed*
+Other changes                                            *nvim-changed*
 
 This section documents various low-level behavior changes.
 
 |mkdir()| behaviour changed:
-1. Assuming /tmp/foo does not exist and /tmp can be written to
+- 1. Assuming /tmp/foo does not exist and /tmp can be written to
-   mkdir('/tmp/foo/bar', 'p', 0700) will create both /tmp/foo and /tmp/foo/bar
+     mkdir('/tmp/foo/bar', 'p', 0700) will create both /tmp/foo and
-   with 0700 permissions. Vim mkdir will create /tmp/foo with 0755.
+     /tmp/foo/bar with 0700 permissions. Vim mkdir will create /tmp/foo with
-2. If you try to create an existing directory with `'p'` (e.g. mkdir('/',
+     0755.
-   'p')) mkdir() will silently exit. In Vim this was an error.
+- 2. If you try to create an existing directory with `'p'` (e.g. mkdir('/',
-3. mkdir() error messages now include strerror() text when mkdir fails.
+     'p')) mkdir() will silently exit. In Vim this was an error.
+- 3. mkdir() error messages now include strerror() text when mkdir fails.
 
 |string()| and |:echo| behaviour changed:
-1. No maximum recursion depth limit is applied to nested container
+- 1. No maximum recursion depth limit is applied to nested container
-   structures.
+     structures.
-2. |string()| fails immediately on nested containers, not when recursion limit
+- 2. |string()| fails immediately on nested containers, not when recursion
-   was exceeded.
+     limit was exceeded.
-3. When |:echo| encounters duplicate containers like >vim
+- 3. When |:echo| encounters duplicate containers like >vim
-
        let l = []
        echo [l, l]
-<
+<     it does not use "[...]" (was: "[[], [...]]", now: "[[], []]"). "..." is
-   it does not use "[...]" (was: "[[], [...]]", now: "[[], []]"). "..." is
+     only used for recursive containers.
-   only used for recursive containers.
+- 4. |:echo| printing nested containers adds "@level" after "..." designating
-4. |:echo| printing nested containers adds "@level" after "..." designating
+     the level at which recursive container was printed: |:echo-self-refer|.
-   the level at which recursive container was printed: |:echo-self-refer|.
+     Same thing applies to |string()| (though it uses construct like
-   Same thing applies to |string()| (though it uses construct like
+     "{E724@level}"), but this is not reliable because |string()| continues to
-   "{E724@level}"), but this is not reliable because |string()| continues to
+     error out.
-   error out.
+- 5. Stringifyed infinite and NaN values now use |str2float()| and can be
-5. Stringifyed infinite and NaN values now use |str2float()| and can be evaled
+     evaled back.
-   back.
+- 6. (internal) Trying to print or stringify VAR_UNKNOWN in Vim results in
-6. (internal) Trying to print or stringify VAR_UNKNOWN in Vim results in
+     nothing, E908, in Nvim it is internal error.
-   nothing, E908, in Nvim it is internal error.
 
 |json_decode()| behaviour changed:
-1. It may output |msgpack-special-dict|.
+- 1. It may output |msgpack-special-dict|.
-2. |msgpack-special-dict| is emitted also in case of duplicate keys, while in
+- 2. |msgpack-special-dict| is emitted also in case of duplicate keys, while
-   Vim it errors out.
+     in Vim it errors out.
-3. It accepts only valid JSON.  Trailing commas are not accepted.
+- 3. It accepts only valid JSON.  Trailing commas are not accepted.
 
 |json_encode()| behaviour slightly changed: now |msgpack-special-dict| values
 are accepted, but |v:none| is not.
@@ -522,38 +512,37 @@ Lua interface (|lua.txt|):
   'runtimepath'. |lua-module-load|
 
 Commands:
-  |:doautocmd| does not warn about "No matching autocommands".
+- |:doautocmd| does not warn about "No matching autocommands".
-  |:wincmd| accepts a count.
+- |:wincmd| accepts a count.
-  `:write!` does not show a prompt if the file was updated externally.
+- `:write!` does not show a prompt if the file was updated externally.
-  |:=| does not accept |ex-flags|. With an arg it is equivalent to |:lua=|
+- |:=| does not accept |ex-flags|. With an arg it is equivalent to |:lua=|
 
 Command-line:
-  The meanings of arrow keys do not change depending on 'wildoptions'.
+- The meanings of arrow keys do not change depending on 'wildoptions'.
 
 Functions:
-  |input()| and |inputdialog()| support for each other’s features (return on
+- |input()| and |inputdialog()| support for each other’s features (return on
   cancel and completion respectively) via dictionary argument (replaces all
   other arguments if used), and "cancelreturn" can have any type if passed in
   a dictionary.
-  |input()| and |inputdialog()| support user-defined cmdline highlighting.
+- |input()| and |inputdialog()| support user-defined cmdline highlighting.
 
 Highlight groups:
-  |hl-ColorColumn|, |hl-CursorColumn| are lower priority than most other
+- |hl-ColorColumn|, |hl-CursorColumn| are lower priority than most other
   groups
-  |hl-CurSearch| highlights match under cursor instead of last match found
+- |hl-CurSearch| highlights match under cursor instead of last match found
   using |n| or |N|
-  |hl-CursorLine| is low-priority unless foreground color is set
+- |hl-CursorLine| is low-priority unless foreground color is set
-  |hl-VertSplit| superseded by |hl-WinSeparator|
+- |hl-VertSplit| superseded by |hl-WinSeparator|
-  Highlight groups names are allowed to contain `@` characters.
+- Highlight groups names are allowed to contain `@` characters.
-  It is an error to define a highlight group with a name that doesn't match
+  - It is an error to define a highlight group with a name that doesn't match
-  the regexp `[a-zA-Z0-9_.@-]*` (see |group-name|).
+    the regexp `[a-zA-Z0-9_.@-]*` (see |group-name|).
 
-Macro/|recording| behavior
+Macro (|recording|) behavior:
-  Replay of a macro recorded during :lmap produces the same actions as when it
+- Replay of a macro recorded during :lmap produces the same actions as when it
   was recorded. In Vim if a macro is recorded while using :lmap'ped keys then
   the behaviour during record and replay differs.
-
+- 'keymap' is implemented via :lmap instead of :lnoremap so that you can use
-  'keymap' is implemented via :lmap instead of :lnoremap so that you can use
   macros and 'keymap' at the same time. This also means you can use |:imap| on
   the results of keys from 'keymap'.
 
@@ -564,13 +553,13 @@ Mappings:
   lhs of a mapping.
 
 Motion:
-  The |jumplist| avoids useless/phantom jumps.
+- The |jumplist| avoids useless/phantom jumps.
 
 Performance:
-  Folds are not updated during insert-mode.
+- Folds are not updated during insert-mode.
 
 Syntax highlighting:
-  syncolor.vim has been removed. Nvim now sets up default highlighting groups
+- syncolor.vim has been removed. Nvim now sets up default highlighting groups
   automatically for both light and dark backgrounds, regardless of whether or
   not syntax highlighting is enabled. This means that |:syntax-on| and
   |:syntax-enable| are now identical. Users who previously used an
@@ -578,10 +567,10 @@ Syntax highlighting:
   colorscheme. |:colorscheme|
 
 Vimscript compatibility:
-  `count` does not alias to |v:count|
+- `count` does not alias to |v:count|
-  `errmsg` does not alias to |v:errmsg|
+- `errmsg` does not alias to |v:errmsg|
-  `shell_error` does not alias to |v:shell_error|
+- `shell_error` does not alias to |v:shell_error|
-  `this_session` does not alias to |v:this_session|
+- `this_session` does not alias to |v:this_session|
 
 Working directory (Vim implemented some of these after Nvim):
 - |DirChanged| and |DirChangedPre| can be triggered when switching to another
@@ -600,7 +589,7 @@ Autocommands:
   instead of the Primary Device Attributes response. |v:termresponse|
 
 ==============================================================================
-Missing features					 *nvim-missing*
+Missing features                                         *nvim-missing*
 
 These legacy Vim features are not yet implemented:
 
@@ -610,75 +599,75 @@ These legacy Vim features are not yet implemented:
 - *'previewpopup'*
 
 ==============================================================================
-Removed legacy features					 *nvim-removed*
+Removed legacy features                                  *nvim-removed*
 
 These Vim features were intentionally removed from Nvim.
 
 Aliases:
-  ex        (alias for "nvim -e")
+- ex        (alias for "nvim -e")
-  exim      (alias for "nvim -E")
+- exim      (alias for "nvim -E")
-  gex       (GUI)
+- gex       (GUI)
-  gview     (GUI)
+- gview     (GUI)
-  gvim      (GUI)
+- gvim      (GUI)
-  gvimdiff  (GUI)
+- gvimdiff  (GUI)
-  rgview    (GUI)
+- rgview    (GUI)
-  rgvim     (GUI)
+- rgvim     (GUI)
-  rview
+- rview
-  rvim
+- rvim
-  view      (alias for "nvim -R")
+- view      (alias for "nvim -R")
-  vimdiff   (alias for "nvim -d" |diff-mode|)
+- vimdiff   (alias for "nvim -d" |diff-mode|)
 
 Commands:
-  :behave
+- :behave
-  :fixdel
+- :fixdel
-  *hardcopy* `:hardcopy` was removed. Instead, use `:TOhtml` and print the
+- *hardcopy* `:hardcopy` was removed. Instead, use `:TOhtml` and print the
   resulting HTML using a web browser or other HTML viewer.
-  :helpfind
+- :helpfind
-  :mode (no longer accepts an argument)
+- :mode (no longer accepts an argument)
-  :open
+- :open
-  :Print
+- :Print
-  :promptfind
+- :promptfind
-  :promptrepl
+- :promptrepl
-  :scriptversion (always version 1)
+- :scriptversion (always version 1)
-  :shell
+- :shell
-  :sleep! (does not hide the cursor; same as :sleep)
+- :sleep! (does not hide the cursor; same as :sleep)
-  :smile
+- :smile
-  :tearoff
+- :tearoff
-  :cstag
+- :cstag
-  :cscope
+- :cscope
-  :lcscope
+- :lcscope
-  :scscope
+- :scscope
-  :Vimuntar
+- :Vimuntar
-  The old `:TOhtml`, replaced by a Lua version (contains many differences)
+- `:TOhtml` was replaced by a Lua version (with various differences)
 
 Compile-time features:
-  Emacs tags support
+- Emacs tags support
-  X11 integration (see |x11-selection|)
+- X11 integration (see |x11-selection|)
 
 Cscope:
                                                                       *cscope*
-  Cscope support was removed in favour of plugin-based solutions such as:
+- Cscope support was removed in favour of plugin-based solutions such as:
   https://github.com/dhananjaylatkar/cscope_maps.nvim
 
 Eval:
-  Vim9script
+- Vim9script
-  *cscope_connection()*
+- *cscope_connection()*
-  *err_teapot()*
+- *err_teapot()*
-  *js_encode()*
+- *js_encode()*
-  *js_decode()*
+- *js_decode()*
-  *v:none* (used by Vim to represent JavaScript "undefined"); use |v:null| instead.
+- *v:none* (used by Vim to represent JavaScript "undefined"); use |v:null| instead.
-  *v:sizeofint*
+- *v:sizeofint*
-  *v:sizeoflong*
+- *v:sizeoflong*
-  *v:sizeofpointer*
+- *v:sizeofpointer*
 
 Events:
-  *SafeStateAgain*
+- *SafeStateAgain*
-  *SigUSR1* Use |Signal| to detect `SIGUSR1` signal instead.
+- *SigUSR1* Use |Signal| to detect `SIGUSR1` signal instead.
 
 Highlight groups:
-  *hl-StatusLineTerm* *hl-StatusLineTermNC* are unnecessary because Nvim
+- *hl-StatusLineTerm* *hl-StatusLineTermNC* are unnecessary because Nvim
-    supports 'winhighlight' window-local highlights.
+  supports 'winhighlight' window-local highlights. For example, to mimic Vim's
-    For example, to mimic Vim's StatusLineTerm:  >vim
+  StatusLineTerm:  >vim
       hi StatusLineTerm ctermfg=black ctermbg=green
       hi StatusLineTermNC ctermfg=green
       autocmd TermOpen,WinEnter * if &buftype=='terminal'
@@ -687,48 +676,45 @@ Highlight groups:
 <
 
 Options:
-  *'aleph'* *'al'*
+- *'aleph'* *'al'*
-  antialias
+- antialias
-  'backspace' no longer supports number values. Instead:
+- 'backspace' no longer supports number values. Instead:
     - for `backspace=0` set `backspace=` (empty)
     - for `backspace=1` set `backspace=indent,eol`
     - for `backspace=2` set `backspace=indent,eol,start` (default behavior in Nvim)
     - for `backspace=3` set `backspace=indent,eol,nostop`
-  *'balloondelay'* *'bdlay'*
+- *'balloondelay'* *'bdlay'*
-  *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
+- *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
-  *'balloonexpr'* *'bexpr'*
+- *'balloonexpr'* *'bexpr'*
-  bioskey (MS-DOS)
+- bioskey (MS-DOS)
-  conskey (MS-DOS)
+- conskey (MS-DOS)
-  *'cp'* *'nocompatible'* *'nocp'* *'compatible'* (Nvim is always "nocompatible".)
+- *'cp'* *'nocompatible'* *'nocp'* *'compatible'* (Nvim is always "nocompatible".)
-  'cpoptions' (gjpkHw<*- and all POSIX flags were removed)
+- 'cpoptions' (gjpkHw<*- and all POSIX flags were removed)
-  *'cryptmethod'* *'cm'* *'key'* (Vim encryption implementation)
+- *'cryptmethod'* *'cm'* *'key'* (Vim encryption implementation)
-  cscopepathcomp
+- cscopepathcomp
-  cscopeprg
+- cscopeprg
-  cscopequickfix
+- cscopequickfix
-  cscoperelative
+- cscoperelative
-  cscopetag
+- cscopetag
-  cscopetagorder
+- cscopetagorder
-  cscopeverbose
+- cscopeverbose
-  *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
+- *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
-  'encoding' ("utf-8" is always used)
+- 'encoding' ("utf-8" is always used)
-  esckeys
+- esckeys
-  'guioptions' "t" flag was removed
+- 'guioptions' "t" flag was removed
-  *'guifontset'* *'gfs'* (Use 'guifont' instead.)
+- *'guifontset'* *'gfs'* (Use 'guifont' instead.)
-  *'guipty'* (Nvim uses pipes and PTYs consistently on all platforms.)
+- *'guipty'* (Nvim uses pipes and PTYs consistently on all platforms.)
-  'highlight' (Names of builtin |highlight-groups| cannot be changed.)
+- 'highlight' (Names of builtin |highlight-groups| cannot be changed.)
-  *'hkmap'* *'hk'* use `set keymap=hebrew` instead.
+- *'hkmap'* *'hk'* use `set keymap=hebrew` instead.
-  *'hkmapp'* *'hkp'* use `set keymap=hebrewp` instead.
+- *'hkmapp'* *'hkp'* use `set keymap=hebrewp` instead.
-  keyprotocol
+- keyprotocol
-
+- *'pastetoggle'* *'pt'* Just Paste It.™ |paste| is handled automatically when
-  *'pastetoggle'* *'pt'* Just Paste It.™ |paste| is handled automatically when
   you paste text using your terminal's or GUI's paste feature (CTRL-SHIFT-v,
   CMD-v (macOS), middle-click, …).
-
+- *'imactivatefunc'* *'imaf'*
-  *'imactivatefunc'* *'imaf'*
+- *'imactivatekey'* *'imak'*
-  *'imactivatekey'* *'imak'*
+- *'imstatusfunc'* *'imsf'*
-  *'imstatusfunc'* *'imsf'*
+- *'insertmode'* *'im'* Use the following script to emulate 'insertmode': >vim
-  *'insertmode'* *'im'* Use the following script to emulate 'insertmode':
->vim
     autocmd BufWinEnter * startinsert
     inoremap <Esc> <C-X><C-Z><C-]>
     inoremap <C-C> <C-X><C-Z>
@@ -754,50 +740,44 @@ Options:
         end
       end)
     EOF
-<
+- *'macatsui'*
-  *'macatsui'*
+- *'maxcombine'* *'mco'* : Nvim counts maximum character sizes in bytes, not
-  *'maxcombine'* *'mco'*
+  codepoints. This is guaranteed to be big enough to always fit all chars
-    Nvim counts maximum character sizes in bytes, not codepoints. This is
+  properly displayed in vim with 'maxcombine' set to 6.
-    guaranteed to be big enough to always fit all chars properly displayed
+  - You can still edit text with larger characters than fits in the screen
-    in vim with 'maxcombine' set to 6.
+    buffer, you just can't see them. Use |g8| or |ga|. See |mbyte-combining|.
-
+  - NOTE: the rexexp engine still has a hard-coded limit of considering
-    You can still edit text with larger characters than fits in the screen buffer,
-    you just can't see them. Use |g8| or |ga|. See |mbyte-combining|.
-
-    NOTE: the rexexp engine still has a hard-coded limit of considering
     6 composing chars only.
-
+- *'maxmem'* Nvim delegates memory-management to the OS.
-  *'maxmem'* Nvim delegates memory-management to the OS.
+- *'maxmemtot'* Nvim delegates memory-management to the OS.
-  *'maxmemtot'* Nvim delegates memory-management to the OS.
+- printoptions
-  printoptions
+- *'printdevice'*
-  *'printdevice'*
+- *'printencoding'*
-  *'printencoding'*
+- *'printexpr'*
-  *'printexpr'*
+- *'printfont'*
-  *'printfont'*
+- *'printheader'*
-  *'printheader'*
+- *'printmbcharset'*
-  *'printmbcharset'*
+- *'prompt'* *'noprompt'*
-  *'prompt'* *'noprompt'*
+- *'remap'* *'noremap'*
-  *'remap'* *'noremap'*
+- *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
-  *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
+- *'secure'* : Everything is allowed in 'exrc' files, because they must be
-  *'secure'*
+  explicitly marked as "trusted".
-    Everything is allowed in 'exrc' files since they must be explicitly marked
+- *'shelltype'*
-    trusted.
+- 'shortmess' flags: *shm-f* *shm-n* *shm-x* *shm-i* (behave like always on)
-  *'shelltype'*
+- *'shortname'* *'sn'* *'noshortname'* *'nosn'*
-  'shortmess' flags: *shm-f* *shm-n* *shm-x* *shm-i* (behave like always on)
+- *'swapsync'* *'sws'*
-  *'shortname'* *'sn'* *'noshortname'* *'nosn'*
+- *'termencoding'* *'tenc'* (Vim 7.4.852 also removed this for Windows)
-  *'swapsync'* *'sws'*
+- *'terse'* *'noterse'* (Add "s" to 'shortmess' instead)
-  *'termencoding'* *'tenc'* (Vim 7.4.852 also removed this for Windows)
+- textauto
-  *'terse'* *'noterse'* (Add "s" to 'shortmess' instead)
+- textmode
-  textauto
+- *'toolbar'* *'tb'*
-  textmode
+- *'toolbariconsize'* *'tbis'*
-  *'toolbar'* *'tb'*
+- *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
-  *'toolbariconsize'* *'tbis'*
+- *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
-  *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
+- *'ttymouse'* *'ttym'*
-  *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
+- *'ttyscroll'* *'tsl'*
-  *'ttymouse'* *'ttym'*
+- *'ttytype'* *'tty'*
-  *'ttyscroll'* *'tsl'*
+- weirdinvert
-  *'ttytype'* *'tty'*
-  weirdinvert
 
 Plugins:
 
@@ -813,47 +793,47 @@ Providers:
 - *if_tcl*
 
 Startup:
-  --literal (file args are always literal; to expand wildcards on Windows, use
+- `--literal`: File args are always literal; to expand wildcards on Windows,
-    |:n| e.g. `nvim +"n *"`)
+  use |:n| e.g. `nvim +"n *"`
-  Easy mode: eview, evim, nvim -y
+- Easy mode: eview, evim, nvim -y
-  Restricted mode: rview, rvim, nvim -Z
+- Restricted mode: rview, rvim, nvim -Z
-  Vi mode: nvim -v
+- Vi mode: nvim -v
 
 Test functions:
-  test_alloc_fail()
+- test_alloc_fail()
-  test_autochdir()
+- test_autochdir()
-  test_disable_char_avail()
+- test_disable_char_avail()
-  test_feedinput()
+- test_feedinput()
-  test_garbagecollect_soon
+- test_garbagecollect_soon
-  test_getvalue()
+- test_getvalue()
-  test_ignore_error()
+- test_ignore_error()
-  test_null_blob()
+- test_null_blob()
-  test_null_channel()
+- test_null_channel()
-  test_null_dict()
+- test_null_dict()
-  test_null_function()
+- test_null_function()
-  test_null_job()
+- test_null_job()
-  test_null_list()
+- test_null_list()
-  test_null_partial()
+- test_null_partial()
-  test_null_string()
+- test_null_string()
-  test_option_not_set()
+- test_option_not_set()
-  test_override()
+- test_override()
-  test_refcount()
+- test_refcount()
-  test_scrollbar()
+- test_scrollbar()
-  test_setmouse()
+- test_setmouse()
-  test_settime()
+- test_settime()
-  test_srand_seed()
+- test_srand_seed()
 
 TUI:
-			  *t_xx* *termcap-options* *t_AB* *t_Sb* *t_vb* *t_SI*
+                          *t_xx* *termcap-options* *t_AB* *t_Sb* *t_vb* *t_SI*
-  Nvim does not have special `t_XX` options nor <t_XX> keycodes to configure
+- Nvim does not have special `t_XX` options nor <t_XX> keycodes to configure
   terminal capabilities. Instead Nvim treats the terminal as any other UI,
   e.g. 'guicursor' sets the terminal cursor style if possible.
 
-			  *termcap*
+                          *termcap*
-  Nvim never uses the termcap database, only |terminfo| and |builtin-terms|.
+- Nvim never uses the termcap database, only |terminfo| and |builtin-terms|.
 
-			  *xterm-8bit* *xterm-8-bit*
+                          *xterm-8bit* *xterm-8-bit*
-  Xterm can be run in a mode where it uses true 8-bit CSI.  Supporting this
+- Xterm can be run in a mode where it uses true 8-bit CSI.  Supporting this
   requires autodetection of whether the terminal is in UTF-8 mode or non-UTF-8
   mode, as the 8-bit CSI character has to be written differently in each case.
   Vim issues a "request version" sequence to the terminal at startup and looks

scripts/gen_help_html.lua

@@ -66,10 +66,12 @@ local new_layout = {
   ['lua.txt'] = true,
   ['luaref.txt'] = true,
   ['news.txt'] = true,
+  ['news-0.9.txt'] = true,
   ['nvim.txt'] = true,
   ['pi_health.txt'] = true,
   ['provider.txt'] = true,
   ['ui.txt'] = true,
+  ['vim_diff.txt'] = true,
 }
 
 -- TODO: These known invalid |links| require an update to the relevant docs.