From 144279ef30a432ac8416746e3491f3120ae9b4e8 Mon Sep 17 00:00:00 2001 From: Christian Clason Date: Fri, 3 Feb 2023 09:18:18 +0100 Subject: vim-patch:be4e01637e71 (#22103) Update runtime files. https://github.com/vim/vim/commit/be4e01637e71c8d5095c33b9861fd70b41476732 Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index b1af90a604..1f91b89322 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -3864,8 +3864,8 @@ A jump table for the options with a short description can be found at |Q_op|. are left blank. *lcs-multispace* multispace:c... - One or more characters to use cyclically to show for - multiple consecutive spaces. Overrides the "space" + One or more characters to use cyclically to show for + multiple consecutive spaces. Overrides the "space" setting, except for single spaces. When omitted, the "space" setting is used. For example, `:set listchars=multispace:---+` shows ten consecutive @@ -6205,8 +6205,8 @@ A jump table for the options with a short description can be found at |Q_op|. windows. * - Set highlight group to User{N}, where {N} is taken from the minwid field, e.g. %1*. Restore normal highlight with %* or %0*. - The difference between User{N} and StatusLine will be applied - to StatusLineNC for the statusline of non-current windows. + The difference between User{N} and StatusLine will be applied to + StatusLineNC for the statusline of non-current windows. The number N must be between 1 and 9. See |hl-User1..9| When displaying a flag, Vim removes the leading comma, if any, when -- cgit From 625e990976540a0e2d2bccb98deb57d0919d1e89 Mon Sep 17 00:00:00 2001 From: bfredl Date: Wed, 8 Feb 2023 16:16:16 +0100 Subject: refactor(ui): cleanup 'redrawdebug', introduce "flush" mode --- runtime/doc/options.txt | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 1f91b89322..17f1c822ff 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4765,7 +4765,7 @@ A jump table for the options with a short description can be found at |Q_op|. Flags to change the way redrawing works, for debugging purposes. Most useful with 'writedelay' set to some reasonable value. Supports the following flags: - compositor Indicate what redraws come from the compositor + compositor Indicate each redraw event handled by the compositor by briefly flashing the redrawn regions in colors indicating the redraw type. These are the highlight groups used (and their default colors): @@ -4777,6 +4777,11 @@ A jump table for the options with a short description can be found at |Q_op|. RedrawDebugRecompose guibg=Red redraw generated by the compositor itself, due to a grid being moved or deleted. + line introduce a delay after each line drawn on the screen. + When using the TUI or another single-grid UI, "compositor" + gives more information and should be preferred (every + line is processed as a separate event by the compositor) + flush introduce a delay after each "flush" event. nothrottle Turn off throttling of the message grid. This is an optimization that joins many small scrolls to one larger scroll when drawing the message area (with @@ -4786,7 +4791,7 @@ A jump table for the options with a short description can be found at |Q_op|. useful when running nvim inside a debugger (and the test suite). nodelta Send all internally redrawn cells to the UI, even if - they are unchanged from the already displayed state. + they are unchanged from the already displayed state. *'redrawtime'* *'rdt'* 'redrawtime' 'rdt' number (default 2000) @@ -7372,8 +7377,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'writedelay'* *'wd'* 'writedelay' 'wd' number (default 0) global - The number of milliseconds to wait for each character sent to the - screen. When positive, characters are sent to the UI one by one. - See 'redrawdebug' for more options. For debugging purposes. + Only takes effect toghether with 'redrawdebug'. + The number of milliseconds to wait after each line or each flush vim:tw=78:ts=8:noet:ft=help:norl: -- cgit From 374955bcc571dff05f068ec18d0f578d1f334c5f Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Sat, 11 Feb 2023 20:00:31 +0800 Subject: vim-patch:9.0.1300: 'statusline' only supports one "%=" item (#22218) Problem: 'statusline' only supports one "%=" item. Solution: Add support for multiple "%=" items. (TJ DeVries, Yegappan Lakshmanan, closes vim/vim#11970, closes vim/vim#11965) https://github.com/vim/vim/commit/3ec78f973fdaec2cea8e036ed38037b2fe40670b Co-authored-by: Yegappan Lakshmanan --- runtime/doc/options.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 17f1c822ff..e4106358f1 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -6201,8 +6201,10 @@ A jump table for the options with a short description can be found at |Q_op|. this label. < - Where to truncate line if too long. Default is at the start. No width fields allowed. - = - Separation point between alignment sections. Each section will - be separated by an equal number of spaces. + = - Separation point between alignment sections. Each section will + be separated by an equal number of spaces. With one %= what + comes after it will be right-aligned. With two %= there is a + middle part, with white space left and right of it. No width fields allowed. # - Set highlight group. The name must follow and then a # again. Thus use %#HLname# for highlight group HLname. The same -- cgit From ee26b227e15abc263195d4c746d5dba9f0e6dec4 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Tue, 21 Feb 2023 23:50:29 +0800 Subject: vim-patch:partial:938ae280c79b (#22356) Update runtime files. https://github.com/vim/vim/commit/938ae280c79b8cdb0fca60336ec4c090ecd8bb5a Partially skip autocmd.txt: needs patch 8.2.5011. Partially skip builtin.txt: needs patch 9.0.0411. Partially skip eval.txt: needs patch 8.2.3783. Cherry-pick :map-meta-keys from patch 9.0.1276. Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index e4106358f1..d13ab8c393 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1186,7 +1186,7 @@ A jump table for the options with a short description can be found at |Q_op|. case mapping, the current locale is not effective. This probably only matters for Turkish. - *'cdhome'* *'cdh'* + *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'* 'cdhome' 'cdh' boolean (default: off) global When on, |:cd|, |:tcd| and |:lcd| without an argument changes the @@ -4291,7 +4291,7 @@ A jump table for the options with a short description can be found at |Q_op|. The 'mousemodel' option is set by the |:behave| command. - *'mousemoveevent'* *'mousemev'* + *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'* 'mousemoveevent' 'mousemev' boolean (default off) global When on, mouse move events are delivered to the input queue and are @@ -5550,7 +5550,7 @@ A jump table for the options with a short description can be found at |Q_op|. A don't give the "ATTENTION" message when an existing *shm-A* swap file is found I don't give the intro message when starting Vim, *shm-I* - see |:intro| + see |:intro| c don't give |ins-completion-menu| messages; for *shm-c* example, "-- XXX completion (YYY)", "match 1 of 2", "The only match", "Pattern not found", "Back at original", etc. @@ -5559,8 +5559,8 @@ A jump table for the options with a short description can be found at |Q_op|. q use "recording" instead of "recording @a" *shm-q* F don't give the file info when editing a file, like *shm-F* `:silent` was used for the command - S do not show search count message when searching, e.g. *shm-S* - "[1/5]" + S do not show search count message when searching, e.g. *shm-S* + "[1/5]" This gives you the opportunity to avoid that a change between buffers requires you to hit , but still gives as useful a message as @@ -5709,7 +5709,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'signcolumn' 'scl' string (default "auto") local to window When and how to draw the signcolumn. Valid values are: - "auto" only when there is a sign to display + "auto" only when there is a sign to display "auto:[1-9]" resize to accommodate multiple signs up to the given number (maximum 9), e.g. "auto:4" "auto:[1-8]-[2-9]" @@ -5718,8 +5718,8 @@ A jump table for the options with a short description can be found at |Q_op|. at least the given minimum (maximum 8) fixed space. The minimum number should always be less than the maximum number, e.g. "auto:2-5" - "no" never - "yes" always + "no" never + "yes" always "yes:[1-9]" always, with fixed space for signs up to the given number (maximum 9), e.g. "yes:3" "number" display signs in the 'number' column. If the number -- cgit From 0b36145c696fb58e002169edd4f9a1d9a8176fc3 Mon Sep 17 00:00:00 2001 From: Luuk van Baal Date: Wed, 22 Feb 2023 16:23:24 +0100 Subject: docs: mention getmousepos() for click execute function label close #18741 close #11312 --- runtime/doc/options.txt | 2 ++ 1 file changed, 2 insertions(+) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index d13ab8c393..2260cd8377 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -6199,6 +6199,8 @@ A jump table for the options with a short description can be found at |Q_op|. is a bug that denotes that new mouse button recognition was added without modifying code that reacts on mouse clicks on this label. + Use |getmousepos()|.winid in the specified function to get the + corresponding window id of the clicked item. < - Where to truncate line if too long. Default is at the start. No width fields allowed. = - Separation point between alignment sections. Each section will -- cgit From 6752f1005d26c93a033d856a60b7b296f3e51634 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Wed, 14 Dec 2022 19:58:18 +0100 Subject: docs: naming conventions, guidelines close #21063 --- runtime/doc/options.txt | 37 +++++++++++++++---------------------- 1 file changed, 15 insertions(+), 22 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 2260cd8377..f44b6f28e3 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -401,20 +401,15 @@ the system, mostly it is something like 256 or 1024 characters. ============================================================================== 2. Automatically setting options *auto-setting* -Besides changing options with the ":set" command, there are three alternatives -to set options automatically for one or more files: - -1. When starting Vim initializations are read from various places. See - |initialization|. Most of them are performed for all editing sessions, - and some of them depend on the directory where Vim is started. - You can create an initialization file with |:mkvimrc|, |:mkview| and - |:mksession|. -2. If you start editing a new file, the automatic commands are executed. - This can be used to set options for files matching a particular pattern and - many other things. See |autocommand|. -3. If you start editing a new file, and the 'modeline' option is on, a - number of lines at the beginning and end of the file are checked for - modelines. This is explained here. +Besides changing options with the ":set" command, you can set options +automatically in various ways: + +1. With a |config| file or a |startup| argument. You can create an + initialization file with |:mkvimrc|, |:mkview| and |:mksession|. +2. |autocommand|s executed when you edit a file. +3. ".nvim.lua" files in the current directory, if 'exrc' is enabled. +4. |editorconfig| in the current buffer's directory or ancestors. +5. 'modeline' settings found at the beginning or end of the file. See below. *modeline* *vim:* *vi:* *ex:* *E520* There are two forms of modelines. The first form: @@ -2267,15 +2262,13 @@ A jump table for the options with a short description can be found at |Q_op|. *'exrc'* *'ex'* *'noexrc'* *'noex'* 'exrc' 'ex' boolean (default off) global - Enables the reading of .nvim.lua, .nvimrc, and .exrc files in the current - directory. - - The file is only sourced if the user indicates the file is trusted. If - it is, the SHA256 hash of the file contents and the full path of the - file are persisted to a trust database. The user is only prompted - again if the file contents change. See |vim.secure.read()|. + Automatically execute .nvim.lua, .nvimrc, and .exrc files in the + current directory, if the file is in the |trust| list. Use |:trust| to + manage trusted files. See also |vim.secure.read()|. - Use |:trust| to manage the trusted file database. + Compare 'exrc' to |editorconfig|: + - 'exrc' can execute any code; editorconfig only specifies settings. + - 'exrc' is Nvim-specific; editorconfig works in other editors. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. -- cgit From cf07f2baabd3a1a072102e0cacb6d70509ada044 Mon Sep 17 00:00:00 2001 From: bfredl Date: Mon, 27 Feb 2023 12:29:20 +0100 Subject: feat(edit)!: remove old c implementation of hebrew keymap This feature has long been obsolete. The 'keymap' option can be used to support language keymaps, including hebrew and hebrewp (phonetic mapping). There is no need to keep the old c code with hardcoded keymaps for some languages. --- runtime/doc/options.txt | 24 ------------------------ 1 file changed, 24 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index f44b6f28e3..6c5b168402 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -575,16 +575,6 @@ supported use something like this: > *E355* A jump table for the options with a short description can be found at |Q_op|. - *'aleph'* *'al'* *aleph* *Aleph* -'aleph' 'al' number (default 224) - global - The ASCII code for the first letter of the Hebrew alphabet. The - routine that maps the keyboard in Hebrew mode, both in Insert mode - (when hkmap is set) and on the command-line (when hitting CTRL-_) - outputs the Hebrew characters in the range [aleph..aleph+26]. - aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. - See |rileft.txt|. - *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* 'allowrevins' 'ari' boolean (default off) global @@ -3195,20 +3185,6 @@ A jump table for the options with a short description can be found at |Q_op|. each of these histories (see |cmdline-editing|). The maximum value is 10000. - *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* -'hkmap' 'hk' boolean (default off) - global - When on, the keyboard is mapped for the Hebrew character set. - Normally you would set 'allowrevins' and use CTRL-_ in insert mode to - toggle this option. See |rileft.txt|. - - *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* -'hkmapp' 'hkp' boolean (default off) - global - When on, phonetic keyboard mapping is used. 'hkmap' must also be on. - This is useful if you have a non-Hebrew keyboard. - See |rileft.txt|. - *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* 'hlsearch' 'hls' boolean (default on) global -- cgit From 2daf0b37dbfe54a4510c1033531dbaefd168c387 Mon Sep 17 00:00:00 2001 From: ii14 <59243201+ii14@users.noreply.github.com> Date: Mon, 13 Mar 2023 03:29:11 +0100 Subject: feat(options)!: deprecate paste, remove pastetoggle (#22647) we cannot remove 'paste'. It is very common in plugins and configs. 'pastetoggle' can and should be removed though, it's a total waste of everyone's time because it generates bug reports and doesn't work well, and is useless because bracketed-paste works better. --- runtime/doc/options.txt | 97 +------------------------------------------------ 1 file changed, 2 insertions(+), 95 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 6c5b168402..9fff5228f2 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -676,8 +676,6 @@ A jump table for the options with a short description can be found at |Q_op|. line. When 'smartindent' or 'cindent' is on the indent is changed in a different way. - The 'autoindent' option is reset when the 'paste' option is set and - restored when 'paste' is reset. {small difference from Vi: After the indent is deleted when typing or , the cursor position when moving up or down is after the deleted indent; Vi puts the cursor somewhere in the deleted indent}. @@ -1266,7 +1264,6 @@ A jump table for the options with a short description can be found at |Q_op|. See |C-indenting|. When you don't like the way 'cindent' works, try the 'smartindent' option or 'indentexpr'. - This option is not used when 'paste' is set. *'cinkeys'* *'cink'* 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e") @@ -2246,8 +2243,6 @@ A jump table for the options with a short description can be found at |Q_op|. . Spaces are used in indents with the '>' and '<' commands and when 'autoindent' is on. To insert a real tab when 'expandtab' is on, use CTRL-V. See also |:retab| and |ins-expandtab|. - This option is reset when the 'paste' option is set and restored when - the 'paste' option is reset. *'exrc'* *'ex'* *'noexrc'* *'noex'* 'exrc' 'ex' boolean (default off) @@ -2749,9 +2744,8 @@ A jump table for the options with a short description can be found at |Q_op|. 'formatoptions' 'fo' string (default: "tcqj") local to buffer This is a sequence of letters which describes how automatic - formatting is to be done. See |fo-table|. When the 'paste' option is - on, no formatting is done (like 'formatoptions' is empty). Commas can - be inserted for readability. + formatting is to be done. See |fo-table|. Commas can be inserted for + readability. To avoid problems with flags that are added in the future, use the "+=" and "-=" feature of ":set" |add-option-flags|. @@ -3392,7 +3386,6 @@ A jump table for the options with a short description can be found at |Q_op|. When this option is not empty, it overrules the 'cindent' and 'smartindent' indenting. When 'lisp' is set, this option is is only used when 'lispoptions' contains "expr:1". - When 'paste' is set this option is not used for indenting. The expression is evaluated with |v:lnum| set to the line number for which the indent is to be computed. The cursor is also in this line when the expression is evaluated (but it may be moved around). @@ -3761,7 +3754,6 @@ A jump table for the options with a short description can be found at |Q_op|. The '-' character is included in keyword characters. Redefines the "=" operator to use this same indentation algorithm rather than calling an external program if 'equalprg' is empty. - This option is not used when 'paste' is set. *'lispoptions'* *'lop'* 'lispoptions' 'lop' string (default "") @@ -4474,77 +4466,6 @@ A jump table for the options with a short description can be found at |Q_op|. Specifies the nroff macros that separate paragraphs. These are pairs of two letters (see |object-motions|). - *'paste'* *'nopaste'* -'paste' boolean (default off) - global - This option is obsolete; |bracketed-paste-mode| is built-in. - - Put Vim in Paste mode. This is useful if you want to cut or copy - some text from one window and paste it in Vim. This will avoid - unexpected effects. - Setting this option is useful when using Vim in a terminal, where Vim - cannot distinguish between typed text and pasted text. In the GUI, Vim - knows about pasting and will mostly do the right thing without 'paste' - being set. The same is true for a terminal where Vim handles the - mouse clicks itself. - This option is reset when starting the GUI. Thus if you set it in - your vimrc it will work in a terminal, but not in the GUI. Setting - 'paste' in the GUI has side effects: e.g., the Paste toolbar button - will no longer work in Insert mode, because it uses a mapping. - When the 'paste' option is switched on (also when it was already on): - - mapping in Insert mode and Command-line mode is disabled - - abbreviations are disabled - - 'autoindent' is reset - - 'expandtab' is reset - - 'hkmap' is reset - - 'revins' is reset - - 'ruler' is reset - - 'showmatch' is reset - - 'smarttab' is reset - - 'softtabstop' is set to 0 - - 'textwidth' is set to 0 - - 'wrapmargin' is set to 0 - - 'varsofttabstop' is made empty - These options keep their value, but their effect is disabled: - - 'cindent' - - 'formatoptions' is used like it is empty - - 'indentexpr' - - 'lisp' - - 'smartindent' - NOTE: When you start editing another file while the 'paste' option is - on, settings from the modelines or autocommands may change the - settings again, causing trouble when pasting text. You might want to - set the 'paste' option again. - When the 'paste' option is reset the mentioned options are restored to - the value before the moment 'paste' was switched from off to on. - Resetting 'paste' before ever setting it does not have any effect. - Since mapping doesn't work while 'paste' is active, you need to use - the 'pastetoggle' option to toggle the 'paste' option with some key. - - *'pastetoggle'* *'pt'* -'pastetoggle' 'pt' string (default "") - global - When non-empty, specifies the key sequence that toggles the 'paste' - option. This is like specifying a mapping: > - :map {keys} :set invpaste -< Where {keys} is the value of 'pastetoggle'. - The difference is that it will work even when 'paste' is set. - 'pastetoggle' works in Insert mode and Normal mode, but not in - Command-line mode. - Mappings are checked first, thus overrule 'pastetoggle'. However, - when 'paste' is on mappings are ignored in Insert mode, thus you can do - this: > - :map :set paste - :map :set nopaste - :imap :set paste - :imap - :set pastetoggle= -< This will make start paste mode and stop paste mode. - Note that typing in paste mode inserts "", since in paste - mode everything is inserted literally, except the 'pastetoggle' key - sequence. - When the value has several bytes 'ttimeoutlen' applies. - *'pex'* *'patchexpr'* 'patchexpr' 'pex' string (default "") global @@ -4827,8 +4748,6 @@ A jump table for the options with a short description can be found at |Q_op|. Inserting characters in Insert mode will work backwards. See "typing backwards" |ins-reverse|. This option can be toggled with the CTRL-_ command in Insert mode, when 'allowrevins' is set. - This option is reset when 'paste' is set and restored when 'paste' is - reset. *'rightleft'* *'rl'* *'norightleft'* *'norl'* 'rightleft' 'rl' boolean (default off) @@ -4877,8 +4796,6 @@ A jump table for the options with a short description can be found at |Q_op|. separated with a dash. For an empty line "0-1" is shown. For an empty buffer the line number will also be zero: "0,0-1". - This option is reset when 'paste' is set and restored when 'paste' is - reset. If you don't want to see the ruler all the time but want to know where you are, use "g CTRL-G" |g_CTRL-G|. @@ -5610,8 +5527,6 @@ A jump table for the options with a short description can be found at |Q_op|. show the match can be set with 'matchtime'. A Beep is given if there is no match (no matter if the match can be seen or not). - This option is reset when 'paste' is set and restored when 'paste' is - reset. When the 'm' flag is not included in 'cpoptions', typing a character will immediately move the cursor back to where it belongs. See the "sm" field in 'guicursor' for setting the cursor shape and @@ -5733,8 +5648,6 @@ A jump table for the options with a short description can be found at |Q_op|. mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. When using the ">>" command, lines starting with '#' are not shifted right. - This option is reset when 'paste' is set and restored when 'paste' is - reset. *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* 'smarttab' 'sta' boolean (default on) @@ -5749,8 +5662,6 @@ A jump table for the options with a short description can be found at |Q_op|. What gets inserted (a or spaces) depends on the 'expandtab' option. Also see |ins-expandtab|. When 'expandtab' is not set, the number of spaces is minimized by using s. - This option is reset when 'paste' is set and restored when 'paste' is - reset. *'softtabstop'* *'sts'* 'softtabstop' 'sts' number (default 0) @@ -5763,8 +5674,6 @@ A jump table for the options with a short description can be found at |Q_op|. commands like "x" still work on the actual characters. When 'sts' is zero, this feature is off. When 'sts' is negative, the value of 'shiftwidth' is used. - 'softtabstop' is set to 0 when the 'paste' option is set and restored - when 'paste' is reset. See also |ins-expandtab|. When 'expandtab' is not set, the number of spaces is minimized by using s. The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is @@ -6579,8 +6488,6 @@ A jump table for the options with a short description can be found at |Q_op|. Maximum width of text that is being inserted. A longer line will be broken after white space to get this width. A zero value disables this. - 'textwidth' is set to 0 when the 'paste' option is set and restored - when 'paste' is reset. When 'textwidth' is zero, 'wrapmargin' may be used. See also 'formatoptions' and |ins-textwidth|. When 'formatexpr' is set it will be used to break the line. -- cgit From ecc4d0e435d618828b938d78fbded7fbe1314760 Mon Sep 17 00:00:00 2001 From: Enan Ajmain <3nan.ajmain@gmail.com> Date: Mon, 20 Mar 2023 03:25:12 +0600 Subject: fix(shell): on Windows :make does not echo #22728 Problem: On Windows, :make does not display the output of the program it runs. The cause is the default 'shellpipe'. On Linux, nvim uses `tee` to redirect the output to both stdout and the error file. In Windows, for both cmd.exe and powershell, the output is only redirected to the error file. Solution: - On Windows, change the 'shellpipe' default to "2>&1| tee". - Nvim includes `tee` in its Windows package. - Document recommended defaults for powershell. Fixes #12910 --- runtime/doc/options.txt | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 9fff5228f2..36c02fa3cb 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5235,9 +5235,9 @@ A jump table for the options with a short description can be found at |Q_op|. *shell-powershell* To use PowerShell: > let &shell = executable('pwsh') ? 'pwsh' : 'powershell' - let &shellcmdflag = '-NoLogo -NoProfile -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.Encoding]::UTF8;' - let &shellredir = '2>&1 | Out-File -Encoding UTF8 %s; exit $LastExitCode' - let &shellpipe = '2>&1 | Out-File -Encoding UTF8 %s; exit $LastExitCode' + let &shellcmdflag = '-NoLogo -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.UTF8Encoding]::new();$PSDefaultParameterValues[''Out-File:Encoding'']=''utf8'';' + let &shellredir = '2>&1 | %%{ "$_" } | Out-File %s; exit $LastExitCode' + let &shellpipe = '2>&1 | %%{ "$_" } | Tee-Object %s; exit $LastExitCode' set shellquote= shellxquote= < This option cannot be set from a |modeline| or in the |sandbox|, for @@ -5259,8 +5259,7 @@ A jump table for the options with a short description can be found at |Q_op|. security reasons. *'shellpipe'* *'sp'* -'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or - "2>&1| tee") +'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee") global String to be used to put the output of the ":make" command in the error file. See also |:make_makeprg|. See |option-backslash| about @@ -5268,8 +5267,8 @@ A jump table for the options with a short description can be found at |Q_op|. The name of the temporary file can be represented by "%s" if necessary (the file name is appended automatically if no %s appears in the value of this option). - For MS-Windows the default is ">%s 2>&1". The output is directly - saved in a file and not echoed to the screen. + For MS-Windows the default is "2>&1| tee". The stdout and stderr are + saved in a file and echoed to the screen. For Unix the default is "| tee". The stdout of the compiler is saved in a file and echoed to the screen. If the 'shell' option is "csh" or "tcsh" after initializations, the default becomes "|& tee". If the -- cgit From 269dd747b6e61842856031ca14ac26ee884ede4c Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Sun, 2 Apr 2023 23:01:48 +0800 Subject: refactor(defaults)!: change default 'commentstring' value to empty (#22862) --- runtime/doc/options.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 36c02fa3cb..096b334cda 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1390,7 +1390,7 @@ A jump table for the options with a short description can be found at |Q_op|. insert a space. *'commentstring'* *'cms'* *E537* -'commentstring' 'cms' string (default "/*%s*/") +'commentstring' 'cms' string (default "") local to buffer A template for a comment. The "%s" in the value is replaced with the comment text. Currently only used to add markers for folding, see -- cgit From a5c572bd446a89be2dccb2f7479ff1b017074640 Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Tue, 4 Apr 2023 19:07:33 +0200 Subject: docs: fix typos Co-authored-by: Gregory Anders Co-authored-by: Raphael Co-authored-by: C.D. MacEachern Co-authored-by: himanoa --- runtime/doc/options.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 096b334cda..d22a78700f 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4846,7 +4846,7 @@ A jump table for the options with a short description can be found at |Q_op|. pack/ packages |:packadd| parser/ |treesitter| syntax parsers plugin/ plugin scripts |write-plugin| - query/ |treesitter| queries + queries/ |treesitter| queries rplugin/ |remote-plugin| scripts spell/ spell checking files |spell| syntax/ syntax files |mysyntaxfile| @@ -7256,7 +7256,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'writedelay'* *'wd'* 'writedelay' 'wd' number (default 0) global - Only takes effect toghether with 'redrawdebug'. + Only takes effect together with 'redrawdebug'. The number of milliseconds to wait after each line or each flush vim:tw=78:ts=8:noet:ft=help:norl: -- cgit From e4a136f713753e6ace97f419be562567f1ce535f Mon Sep 17 00:00:00 2001 From: bfredl Date: Wed, 12 Apr 2023 22:22:37 +0200 Subject: feat(ex_cmds)!: remove :behave just use the individual options instead. set selection=exclusive set selectmode=mouse,key set mousemodel=popup set keymodel=startsel,stopsel --- runtime/doc/options.txt | 21 --------------------- 1 file changed, 21 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index d22a78700f..b4cad51990 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -3589,7 +3589,6 @@ A jump table for the options with a short description can be found at |Q_op|. stopsel Using a not-shifted special key stops selection. Special keys in this context are the cursor keys, , , and . - The 'keymodel' option is set by the |:behave| command. *'keywordprg'* *'kp'* 'keywordprg' 'kp' string (default ":Man", Windows: ":help") @@ -4168,21 +4167,6 @@ A jump table for the options with a short description can be found at |Q_op|. 'mousehide' hide mouse pointer while typing text 'selectmode' whether to start Select mode or Visual mode - The :behave command provides some "profiles" for mouse behavior. - *:behave* *:be* - :be[have] {model} Set behavior for mouse and selection. Valid - arguments are: - mswin MS-Windows behavior - xterm Xterm behavior - - Using ":behave" changes these options: - option mswin xterm ~ - 'selectmode' "mouse,key" "" - 'mousemodel' "popup" "extend" - 'keymodel' "startsel,stopsel" "" - 'selection' "exclusive" "inclusive" - - *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* 'mousefocus' 'mousef' boolean (default off) global @@ -4250,8 +4234,6 @@ A jump table for the options with a short description can be found at |Q_op|. "g" is " (jump to tag under mouse click) "g" is " ("CTRL-T") - The 'mousemodel' option is set by the |:behave| command. - *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'* 'mousemoveevent' 'mousemev' boolean (default off) global @@ -5013,8 +4995,6 @@ A jump table for the options with a short description can be found at |Q_op|. backwards, you cannot include the last character of a line, when starting in Normal mode and 'virtualedit' empty. - The 'selection' option is set by the |:behave| command. - *'selectmode'* *'slm'* 'selectmode' 'slm' string (default "") global @@ -5025,7 +5005,6 @@ A jump table for the options with a short description can be found at |Q_op|. key when using shifted special keys cmd when using "v", "V" or CTRL-V See |Select-mode|. - The 'selectmode' option is set by the |:behave| command. *'sessionoptions'* *'ssop'* 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, -- cgit From 57221e0d11d1c24bc2abada7559a1d20c5090b62 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Sat, 15 Apr 2023 19:11:29 +0800 Subject: vim-patch:b59ae59a5870 Update runtime files https://github.com/vim/vim/commit/b59ae59a58706e454ef8c78276f021b1f58466e7 Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index b4cad51990..dcaf37af20 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -3332,8 +3332,8 @@ A jump table for the options with a short description can be found at |Q_op|. If the expression starts with s: or ||, then it is replaced with the script ID (|local-function|). Example: > - set includeexpr=s:MyIncludeExpr(v:fname) - set includeexpr=SomeIncludeExpr(v:fname) + setlocal includeexpr=s:MyIncludeExpr(v:fname) + setlocal includeexpr=SomeIncludeExpr(v:fname) < The expression will be evaluated in the |sandbox| when set from a modeline, see |sandbox-option|. -- cgit From 79a69337682ca0e3fc4d0bb9f70d851f8114bc9a Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Mon, 17 Apr 2023 15:32:49 +0800 Subject: vim-patch:partial:6f4754b9f725 Update runtime files https://github.com/vim/vim/commit/6f4754b9f7253d7e4ba527064a24aff1acdb1e8f Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index dcaf37af20..7842394245 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -2563,7 +2563,9 @@ A jump table for the options with a short description can be found at |Q_op|. 'foldexpr' 'fde' string (default: "0") local to window The expression used for when 'foldmethod' is "expr". It is evaluated - for each line to obtain its fold level. See |fold-expr|. + for each line to obtain its fold level. The context is set to the + script where 'foldexpr' was set, script-local items can be accessed. + See |fold-expr| for the usage. The expression will be evaluated in the |sandbox| if set from a modeline, see |sandbox-option|. @@ -2679,7 +2681,9 @@ A jump table for the options with a short description can be found at |Q_op|. 'foldtext' 'fdt' string (default: "foldtext()") local to window An expression which is used to specify the text displayed for a closed - fold. See |fold-foldtext|. + fold. The context is set to the script where 'foldexpr' was set, + script-local items can be accessed. See |fold-foldtext| for the + usage. The expression will be evaluated in the |sandbox| if set from a modeline, see |sandbox-option|. @@ -2720,7 +2724,9 @@ A jump table for the options with a short description can be found at |Q_op|. the script ID (|local-function|). Example: > set formatexpr=s:MyFormatExpr() set formatexpr=SomeFormatExpr() -< +< Otherwise, the expression is evaluated in the context of the script + where the option was set, thus script-local items are available. + The expression will be evaluated in the |sandbox| when set from a modeline, see |sandbox-option|. That stops the option from working, since changing the buffer text is not allowed. @@ -3334,7 +3340,9 @@ A jump table for the options with a short description can be found at |Q_op|. the script ID (|local-function|). Example: > setlocal includeexpr=s:MyIncludeExpr(v:fname) setlocal includeexpr=SomeIncludeExpr(v:fname) -< +< Otherwise, the expression is evaluated in the context of the script + where the option was set, thus script-local items are available. + The expression will be evaluated in the |sandbox| when set from a modeline, see |sandbox-option|. This option cannot be set in a modeline when 'modelineexpr' is off. @@ -3389,11 +3397,14 @@ A jump table for the options with a short description can be found at |Q_op|. The expression is evaluated with |v:lnum| set to the line number for which the indent is to be computed. The cursor is also in this line when the expression is evaluated (but it may be moved around). + If the expression starts with s: or ||, then it is replaced with the script ID (|local-function|). Example: > set indentexpr=s:MyIndentExpr() set indentexpr=SomeIndentExpr() -< +< Otherwise, the expression is evaluated in the context of the script + where the option was set, thus script-local items are available. + The expression must return the number of spaces worth of indent. It can return "-1" to keep the current indent (this means 'autoindent' is used for the indent). -- cgit From d9f78b63361e00a7f623ebb5b869606ac653b180 Mon Sep 17 00:00:00 2001 From: T727 <74924917+T-727@users.noreply.github.com> Date: Sat, 22 Apr 2023 13:04:05 +0300 Subject: docs(powershell): use tee.exe instead of Tee-Object Problem: Tee-Object does not create a file if it does not receive input for example when :grep does not find matches. and so nvim tries to open a nonexistent errorfile causing an error. Solution: use tee.exe instead of Tee-Object --- runtime/doc/options.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 7842394245..46d3f153c2 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5225,9 +5225,9 @@ A jump table for the options with a short description can be found at |Q_op|. *shell-powershell* To use PowerShell: > let &shell = executable('pwsh') ? 'pwsh' : 'powershell' - let &shellcmdflag = '-NoLogo -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.UTF8Encoding]::new();$PSDefaultParameterValues[''Out-File:Encoding'']=''utf8'';' + let &shellcmdflag = '-NoLogo -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.UTF8Encoding]::new();$PSDefaultParameterValues[''Out-File:Encoding'']=''utf8'';Remove-Alias -Force -ErrorAction SilentlyContinue tee;' let &shellredir = '2>&1 | %%{ "$_" } | Out-File %s; exit $LastExitCode' - let &shellpipe = '2>&1 | %%{ "$_" } | Tee-Object %s; exit $LastExitCode' + let &shellpipe = '2>&1 | %%{ "$_" } | tee %s; exit $LastExitCode' set shellquote= shellxquote= < This option cannot be set from a |modeline| or in the |sandbox|, for -- cgit From e3f36377c156749bbdafc46d8a8cd017f378b4b5 Mon Sep 17 00:00:00 2001 From: Christian Clason Date: Sun, 23 Apr 2023 15:22:55 +0200 Subject: vim-patch:71badf9547e8 (#23285) Update runtime files https://github.com/vim/vim/commit/71badf9547e8f89571b9a095183671cbb333d528 Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 46d3f153c2..0aa6769f4e 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5868,11 +5868,12 @@ A jump table for the options with a short description can be found at |Q_op|. global When "on" the commands listed below move the cursor to the first non-blank of the line. When off the cursor is kept in the same column - (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, - CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" - with a linewise operator, with "%" with a count and to buffer changing - commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that - only has a line number, e.g., ":25" or ":+". + (if possible). This applies to the commands: + - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg" + - "d", "<<" and ">>" with a linewise operator + - "%" with a count + - buffer changing commands (CTRL-^, :bnext, :bNext, etc.) + - Ex commands that only have a line number, e.g., ":25" or ":+". In case of buffer changing commands the cursor is placed at the column where it was the last time the buffer was edited. -- cgit From 715587f8e44e941ece6f17eb77620fd1b4719496 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Fri, 28 Apr 2023 21:07:00 +0800 Subject: vim-patch:8.2.3509: undo file is not synced (#23371) Problem: Undo file is not synced. (Sami Farin) Solution: Sync the undo file if 'fsync' is set. (Christian Brabandt, closes vim/vim#8879, closes vim/vim#8920) https://github.com/vim/vim/commit/340dd0fbe462a15a9678cfba02085b4adcc45f02 Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 0aa6769f4e..ba73d79cd3 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -2774,8 +2774,8 @@ A jump table for the options with a short description can be found at |Q_op|. 'fsync' 'fs' boolean (default off) global When on, the OS function fsync() will be called after saving a file - (|:write|, |writefile()|, …), |swap-file| and |shada-file|. This - flushes the file to disk, ensuring that it is safely written. + (|:write|, |writefile()|, …), |swap-file|, |undo-persistence| and |shada-file|. + This flushes the file to disk, ensuring that it is safely written. Slow on some systems: writing buffers, quitting Nvim, and other operations may sometimes take a few seconds. -- cgit From be11f80d018797b514ed7d01cde2e4c8f88cc8d2 Mon Sep 17 00:00:00 2001 From: Luuk van Baal Date: Wed, 26 Apr 2023 01:55:00 +0200 Subject: vim-patch:9.0.0640: cannot scroll by screen line if a line wraps Problem: Cannot scroll by screen line if a line wraps. Solution: Add the 'smoothscroll' option. Only works for CTRL-E and CTRL-Y so far. https://github.com/vim/vim/commit/f6196f424474e2a9c160f2a995fc2691f82b58f9 vim-patch:9.0.0641: missing part of the new option code Problem: Missing part of the new option code. Solution: Add missing WV_SMS. https://github.com/vim/vim/commit/bbbda8fd81f6d720962b67ae885825bad9be4456 Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index ba73d79cd3..7cb88441f1 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5652,6 +5652,14 @@ A jump table for the options with a short description can be found at |Q_op|. option. Also see |ins-expandtab|. When 'expandtab' is not set, the number of spaces is minimized by using s. + *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'* +'smoothscroll' 'sms' boolean (default off) + local to window + Scrolling works with screen lines. When 'wrap' is set and the first + line in the window wraps part of it may not be visible, as if it is + above the window. + NOTE: only partly implemented, works with CTRL-E and CTRL-Y. + *'softtabstop'* *'sts'* 'softtabstop' 'sts' number (default 0) local to buffer -- cgit From 4e4383ffa2b9ec94e703ecbd6178737fc24f6866 Mon Sep 17 00:00:00 2001 From: Luuk van Baal Date: Fri, 28 Apr 2023 16:22:42 +0200 Subject: vim-patch:9.0.1247: divide by zero with 'smoothscroll' set and a narrow window Problem: Divide by zero with 'smoothscroll' set and a narrow window. Solution: Bail out when the window is too narrow. https://github.com/vim/vim/commit/870219c58c0804bdc55419b2e455c06ac715a835 Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 7cb88441f1..ab86e56a62 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5657,8 +5657,10 @@ A jump table for the options with a short description can be found at |Q_op|. local to window Scrolling works with screen lines. When 'wrap' is set and the first line in the window wraps part of it may not be visible, as if it is - above the window. - NOTE: only partly implemented, works with CTRL-E and CTRL-Y. + above the window. "<<<" is displayed at the start of the first line, + highlighted with |hl-NonText|. + NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y + and scrolling with the mouse. *'softtabstop'* *'sts'* 'softtabstop' 'sts' number (default 0) -- cgit From 7e70a1e44b223a51f4d8f06b9fe4c4ef77601f83 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Thu, 4 May 2023 13:43:23 +0800 Subject: vim-patch:9.0.0138: not enough characters accepted for 'spellfile' Problem: Not enough characters accepted for 'spellfile'. Solution: Add vim_is_fname_char() and use it for 'spellfile'. https://github.com/vim/vim/commit/bc49c5f48f89c2d6f4d88ee77f44a11d68293be3 Cherry-pick related doc update from Vim runtime. Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 1 + 1 file changed, 1 insertion(+) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index ab86e56a62..324151ee58 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5706,6 +5706,7 @@ A jump table for the options with a short description can be found at |Q_op|. Name of the word list file where words are added for the |zg| and |zw| commands. It must end in ".{encoding}.add". You need to include the path, otherwise the file is placed in the current directory. + The path may include characters from 'isfname', space, comma and '@'. *E765* It may also be a comma-separated list of names. A count before the |zg| and |zw| commands can be used to access each. This allows using -- cgit From b8d5586d5b0d1e2d25533ee398d16bb2e8412820 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Fri, 5 May 2023 08:18:36 +0800 Subject: refactor: using a different error number for 'mousescroll' Because E548 is linked to 'guicursor' in help. --- runtime/doc/options.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 324151ee58..c87b6f1835 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4254,7 +4254,7 @@ A jump table for the options with a short description can be found at |Q_op|. Warning: Setting this option can make pending mappings to be aborted when the mouse is moved. - *'mousescroll'* + *'mousescroll'* *E5080* 'mousescroll' string (default "ver:3,hor:6") global This option controls the number of lines / columns to scroll by when -- cgit From f76e1ac92eda9cb364a9de49422b45a035256ca6 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Sat, 13 May 2023 08:40:06 +0800 Subject: vim-patch:9.0.1546: some commands for opening a file don't use 'switchbuf' (#23600) Problem: Some commands for opening a file don't use 'switchbuf'. Solution: Use 'switchbuf' for more commands. (Yegappan Lakshmanan, closes vim/vim#12383, closes vim/vim#12381) https://github.com/vim/vim/commit/54be5fb382d2bf25fd1b17ddab8b21f599019b81 Co-authored-by: Yegappan Lakshmanan --- runtime/doc/options.txt | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index c87b6f1835..934e3353fa 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -6201,16 +6201,18 @@ A jump table for the options with a short description can be found at |Q_op|. 'switchbuf' 'swb' string (default "uselast") global This option controls the behavior when switching between buffers. - Mostly for |quickfix| commands some values are also used for other - commands, as mentioned below. + This option is checked, when + - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|, + etc.) + - jumping to a tag using the |:stag| command. + - opening a file using the |CTRL-W_f| or |CTRL-W_F| command. + - jumping to a buffer using a buffer split command (e.g. |:sbuffer|, + |:sbnext|, or |:sbrewind|). Possible values (comma-separated list): - useopen If included, jump to the first open window that - contains the specified buffer (if there is one). - Otherwise: Do not examine other windows. - This setting is checked with |quickfix| commands, when - jumping to errors (":cc", ":cn", "cp", etc.). It is - also used in all buffer related split commands, for - example ":sbuffer", ":sbnext", or ":sbrewind". + useopen If included, jump to the first open window in the + current tab page that contains the specified buffer + (if there is one). Otherwise: Do not examine other + windows. usetab Like "useopen", but also consider windows in other tab pages. split If included, split the current window before loading -- cgit From 08991b078267e5de0a19a136d00d4f71ad651a32 Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Sat, 13 May 2023 21:33:22 +0200 Subject: docs: small fixes Co-authored-by: Christian Clason Co-authored-by: Gregory Anders Co-authored-by: HiPhish Co-authored-by: Julio B Co-authored-by: T727 <74924917+T-727@users.noreply.github.com> Co-authored-by: camoz Co-authored-by: champignoom <66909116+champignoom@users.noreply.github.com> --- runtime/doc/options.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 934e3353fa..9f5a089434 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1324,7 +1324,7 @@ A jump table for the options with a short description can be found at |Q_op|. register. When "unnamed" is also included to the option, yank and delete operations (but not put) will additionally copy the text into register - '*'. See |clipboard|. + "*". See |clipboard|. *'cmdheight'* *'ch'* 'cmdheight' 'ch' number (default 1) @@ -3523,7 +3523,7 @@ A jump table for the options with a short description can be found at |Q_op|. that is not white space or punctuation). For C programs you could use "a-z,A-Z,48-57,_,.,-,>". For a help file it is set to all non-blank printable characters except - '*', '"' and '|' (so that CTRL-] on a command finds the help for that + "*", '"' and '|' (so that CTRL-] on a command finds the help for that command). When the 'lisp' option is on the '-' character is always included. This option also influences syntax highlighting, unless the syntax -- cgit From c11986ed1a816d7ebcb5a5f707e3ef884f278293 Mon Sep 17 00:00:00 2001 From: Christian Clason Date: Mon, 15 May 2023 09:38:32 +0200 Subject: vim-patch:b7398fe41c9e (#23627) Update runtime files https://github.com/vim/vim/commit/b7398fe41c9e1e731d058105a34158871ee83e3f Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 3 +++ 1 file changed, 3 insertions(+) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 9f5a089434..c1e0bccfd3 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -706,6 +706,9 @@ A jump table for the options with a short description can be found at |Q_op|. 'autowriteall' for that. Some buffers will not be written, specifically when 'buftype' is "nowrite", "nofile", "terminal" or "prompt". + USE WITH CARE: If you make temporary changes to a buffer that you + don't want to be saved this option may cause it to be saved anyway. + Renaming the buffer with ":file {name}" may help avoid this. *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* 'autowriteall' 'awa' boolean (default off) -- cgit From c855eee919f2d4edc9b9fa91b277454290fbabfe Mon Sep 17 00:00:00 2001 From: Christian Clason Date: Wed, 24 May 2023 10:04:49 +0200 Subject: feat(term): enable reflow by default (#21124) libvterm v0.3 supports reflow of terminal buffer when Nvim is resized Since v0.3 is now a required dependency, enable it by default to find (and fix) possible issues. Note: Neovim's scrollback buffer does not support reflow (yet), so lines vanishing into the buffer due to a too small window will be restored without reflow. --- runtime/doc/options.txt | 3 +++ 1 file changed, 3 insertions(+) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index c1e0bccfd3..72463af418 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4913,6 +4913,9 @@ A jump table for the options with a short description can be found at |Q_op|. Minimum is 1, maximum is 100000. Only in |terminal| buffers. + Note: Lines that are not visible and kept in scrollback are not + reflown when the terminal buffer is resized horizontally. + *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* 'scrollbind' 'scb' boolean (default off) local to window -- cgit From 21187e1c73e6887ce407164c98320555374387a9 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Mon, 5 Jun 2023 02:19:05 -0700 Subject: defaults: shortmess+=C #23907 Problem: Completion messages such as "scanning tags" are noisy and generally not useful on most systems. Most users probably aren't aware that this is configurable. Solution: Set `shortmess+=C`. --- runtime/doc/options.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 72463af418..4f5f2e8b80 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5393,7 +5393,7 @@ A jump table for the options with a short description can be found at |Q_op|. function to get the effective shiftwidth value. *'shortmess'* *'shm'* -'shortmess' 'shm' string (default "filnxtToOF") +'shortmess' 'shm' string (default "filnxtToOCF") global This option helps to avoid all the |hit-enter| prompts caused by file messages, for example with CTRL-G, and to avoid some other messages. -- cgit From fcfe535e9877cfdc824dc78f2d19e590400d34cd Mon Sep 17 00:00:00 2001 From: Gregory Anders <8965202+gpanders@users.noreply.github.com> Date: Tue, 6 Jun 2023 11:26:29 -0500 Subject: refactor(defaults): do not use C specific default values for options (#22500) The options 'path', 'include', and 'define' all use C-specific default values. This may have made sense a long time ago when Vim was mostly used just for writing C, but this is no longer the case, and we have ample support for filetype specific configuration. Make the default values of these options empty and move the C-specific values into a filetype plugin where they belong. Co-authored-by: zeertzjq --- runtime/doc/options.txt | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 4f5f2e8b80..7729ec5d38 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1396,8 +1396,8 @@ A jump table for the options with a short description can be found at |Q_op|. 'commentstring' 'cms' string (default "") local to buffer A template for a comment. The "%s" in the value is replaced with the - comment text. Currently only used to add markers for folding, see - |fold-marker|. + comment text. For example, C uses "/*%s*/". Currently only used to + add markers for folding, see |fold-marker|. *'complete'* *'cpt'* *E535* 'complete' 'cpt' string (default: ".,w,b,u,t") @@ -1861,7 +1861,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'indentexpr'. *'define'* *'def'* -'define' 'def' string (default "^\s*#\s*define") +'define' 'def' string (default "") global or local to buffer |global-local| Pattern to be used to find a macro definition. It is a search pattern, just like for the "/" command. This option is used for the @@ -1870,8 +1870,7 @@ A jump table for the options with a short description can be found at |Q_op|. {match with 'define'}{non-ID chars}{defined name}{non-ID char} See |option-backslash| about inserting backslashes to include a space or backslash. - The default value is for C programs. For C++ this value would be - useful, to include const type declarations: > + For C++ this value would be useful, to include const type declarations: > ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) < You can also use "\ze" just before the name and continue the pattern to check what is following. E.g. for Javascript, if a function is @@ -3309,12 +3308,11 @@ A jump table for the options with a short description can be found at |Q_op|. |Command-line-mode| is done. *'include'* *'inc'* -'include' 'inc' string (default "^\s*#\s*include") +'include' 'inc' string (default "") global or local to buffer |global-local| Pattern to be used to find an include command. It is a search - pattern, just like for the "/" command (See |pattern|). The default - value is for C programs. This option is used for the commands "[i", - "]I", "[d", etc. + pattern, just like for the "/" command (See |pattern|). This option + is used for the commands "[i", "]I", "[d", etc. Normally the 'isfname' option is used to recognize the file name that comes after the matched pattern. But if "\zs" appears in the pattern then the text matched from "\zs" to the end, or until "\ze" if it @@ -4489,8 +4487,7 @@ A jump table for the options with a short description can be found at |Q_op|. Only normal file name characters can be used, "/\*?[|<>" are illegal. *'path'* *'pa'* *E343* *E345* *E347* *E854* -'path' 'pa' string (default on Unix: ".,/usr/include,," - other systems: ".,,") +'path' 'pa' string (default: ".,,") global or local to buffer |global-local| This is a list of directories which will be searched when using the |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, -- cgit From 473a216a21fdc086ef71e0ca7d40c2fdf5346245 Mon Sep 17 00:00:00 2001 From: Sean Dewar Date: Sun, 11 Jun 2023 12:40:22 +0100 Subject: vim-patch:10e8ff9b2607 (#23977) Update runtime files https://github.com/vim/vim/commit/10e8ff9b26078994cae57c2422b145d37aaf714e Also: - fix a missing `<` in builtin.txt. - edit `:function` `{name}` wording to match the change made for the docs above by Justin in #10619. - link to `*vimrc*` rather than `*init.vim*` in repeat.txt change (as `init.lua` may also be used). Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 7729ec5d38..ff346e878d 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1361,7 +1361,7 @@ A jump table for the options with a short description can be found at |Q_op|. The screen column can be an absolute number, or a number preceded with '+' or '-', which is added to or subtracted from 'textwidth'. > - :set cc=+1 " highlight column after 'textwidth' + :set cc=+1 " highlight column after 'textwidth' :set cc=+1,+2,+3 " highlight three columns after 'textwidth' :hi ColorColumn ctermbg=lightgrey guibg=lightgrey < @@ -5386,7 +5386,7 @@ A jump table for the options with a short description can be found at |Q_op|. local to buffer Number of spaces to use for each step of (auto)indent. Used for |'cindent'|, |>>|, |<<|, etc. - When zero the 'ts' value will be used. Use the |shiftwidth()| + When zero the 'tabstop' value will be used. Use the |shiftwidth()| function to get the effective shiftwidth value. *'shortmess'* *'shm'* @@ -5662,6 +5662,8 @@ A jump table for the options with a short description can be found at |Q_op|. line in the window wraps part of it may not be visible, as if it is above the window. "<<<" is displayed at the start of the first line, highlighted with |hl-NonText|. + You may also want to add "lastline" to the 'display' option to show as + much of the last line as possible. NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y and scrolling with the mouse. @@ -6313,13 +6315,25 @@ A jump table for the options with a short description can be found at |Q_op|. (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim will use a mix of tabs and spaces, but typing and will behave like a tab appears every 4 (or 3) characters. - 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use + This is the recommended way, the file will look the same with other + tools and when listing it in a terminal. + 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use + 'expandtab'. This way you will always insert spaces. The + formatting will never be messed up when 'tabstop' is changed (leave + it at 8 just in case). The file will be a bit larger. + You do need to check if no Tabs exist in the file. You can get rid + of them by first setting 'expandtab' and using `%retab!`, making + sure the value of 'tabstop' is set correctly. + 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use 'expandtab'. This way you will always insert spaces. The formatting will never be messed up when 'tabstop' is changed. - 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a + You do need to check if no Tabs exist in the file, just like in the + item just above. + 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a |modeline| to set these values when editing the file again. Only - works when using Vim to edit the file. - 4. Always set 'tabstop' and 'shiftwidth' to the same value, and + works when using Vim to edit the file, other tools assume a tabstop + is worth 8 spaces. + 5. Always set 'tabstop' and 'shiftwidth' to the same value, and 'noexpandtab'. This should then work (for initial indents only) for any tabstop setting that people use. It might be nice to have tabs after the first non-blank inserted as spaces if you do this -- cgit From 72de8fdeebd1cafeb05d3e5b03e537b8cb99178b Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Sun, 11 Jun 2023 20:04:59 +0800 Subject: vim-patch:f1dcd14fc5d4 (#23986) Update runtime files https://github.com/vim/vim/commit/f1dcd14fc5d4370476cd82895a4479ca2d252e54 :autocmd-block is N/A (Vim9 script) Co-authored-by: Bram Moolenaar --- runtime/doc/options.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index ff346e878d..0f53288608 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5391,7 +5391,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'shortmess'* *'shm'* 'shortmess' 'shm' string (default "filnxtToOCF") - global + global *E1336* This option helps to avoid all the |hit-enter| prompts caused by file messages, for example with CTRL-G, and to avoid some other messages. It is a list of flags: -- cgit From 72a6643b1380cdf6f1153d70eeaffb90bdca30d6 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Mon, 19 Jun 2023 08:40:33 -0700 Subject: docs #24061 - nvim requires rpc responses in reverse order. https://github.com/neovim/neovim/issues/19932 - NVIM_APPNAME: UIs normally should NOT set this. ref #23520 fix #24050 fix #23660 fix #23353 fix #23337 fix #22213 fix #19161 fix #18088 fix #20693 --- runtime/doc/options.txt | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 0f53288608..78d38095a8 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -2088,17 +2088,13 @@ A jump table for the options with a short description can be found at |Q_op|. :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces < - For backwards compatibility with Vim version 3.0 a '>' at the start of the option is removed. - Using "." first in the list is recommended. This means that editing - the same file twice will result in a warning. Using "/tmp" on Unix is - discouraged: When the system crashes you lose the swap file. - "/var/tmp" is often not cleared when rebooting, thus is a better - choice than "/tmp". But others on the computer may be able to see the - files, and it can contain a lot of files, your swap files get lost in - the crowd. That is why a "tmp" directory in your home directory is - tried first. - The use of |:set+=| and |:set-=| is preferred when adding or removing - directories from the list. This avoids problems when a future version - uses another default. + + Editing the same file twice will result in a warning. Using "/tmp" on + is discouraged: if the system crashes you lose the swap file. And + others on the computer may be able to see the files. + Use |:set+=| and |:set-=| when adding or removing directories from the + list, this avoids problems if the Nvim default is changed. + This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. -- cgit From d931b829e92665fd7371b1bb49d22ce25b50a89a Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Wed, 21 Jun 2023 15:40:40 +0200 Subject: fix(docs): vimdoc syntax errors Since https://github.com/neovim/tree-sitter-vimdoc/pull/97 the many cases of *.foo cause parser errors. But even before that, these were erroneously highlighted as (argument), so fixing them is good. --- runtime/doc/options.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 78d38095a8..b58ca8d094 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1449,7 +1449,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'completeslash'* *'csl'* 'completeslash' 'csl' string (default: "") local to buffer - {only for MS-Windows} + only for MS-Windows When this option is set it overrules 'shellslash' for completion: - When this option is set to "slash", a forward slash is used for path completion in insert mode. This is useful when editing HTML tag, or @@ -3741,7 +3741,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'linespace'* *'lsp'* 'linespace' 'lsp' number (default 0) global - {only in the GUI} + only in the GUI Number of pixel lines inserted between characters. Useful if the font uses the full character cell height, making lines touch each other. When non-zero there is room for underlining. @@ -4187,7 +4187,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* 'mousehide' 'mh' boolean (default on) global - {only works in the GUI} + only in the GUI When on, the mouse pointer is hidden when characters are typed. The mouse pointer is restored when the mouse is moved. @@ -4426,7 +4426,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* 'opendevice' 'odev' boolean (default off) global - {only for Windows} + only for Windows Enable reading and writing from devices. This may get Vim stuck on a device that can be opened but doesn't actually do the I/O. Therefore it is off by default. @@ -5323,7 +5323,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* 'shellslash' 'ssl' boolean (default off) global - {only for MS-Windows} + only for MS-Windows When set, a forward slash is used when expanding file names. This is useful when a Unix-like shell is used instead of cmd.exe. Backward slashes can still be typed, but they are changed to forward slashes by @@ -7054,7 +7054,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'winaltkeys'* *'wak'* 'winaltkeys' 'wak' string (default "menu") global - {only used in Win32} + only used in Win32 Some GUI versions allow the access to menu entries by using the ALT key in combination with a character that appears underlined in the menu. This conflicts with the use of the ALT key for mappings and -- cgit From 036da0d07921e67090d1a62c9a4e382ca09d8584 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sat, 24 Jun 2023 13:47:10 +0200 Subject: fix(docs): vimdoc syntax errors gen_help_html: truncate parse-error sample text --- runtime/doc/options.txt | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index b58ca8d094..7ef2195198 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -676,9 +676,6 @@ A jump table for the options with a short description can be found at |Q_op|. line. When 'smartindent' or 'cindent' is on the indent is changed in a different way. - {small difference from Vi: After the indent is deleted when typing - or , the cursor position when moving up or down is after the - deleted indent; Vi puts the cursor somewhere in the deleted indent}. *'autoread'* *'ar'* *'noautoread'* *'noar'* 'autoread' 'ar' boolean (default on) @@ -1866,9 +1863,9 @@ A jump table for the options with a short description can be found at |Q_op|. Pattern to be used to find a macro definition. It is a search pattern, just like for the "/" command. This option is used for the commands like "[i" and "[d" |include-search|. The 'isident' option is - used to recognize the defined name after the match: + used to recognize the defined name after the match: > {match with 'define'}{non-ID chars}{defined name}{non-ID char} - See |option-backslash| about inserting backslashes to include a space +< See |option-backslash| about inserting backslashes to include a space or backslash. For C++ this value would be useful, to include const type declarations: > ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) @@ -4042,9 +4039,9 @@ A jump table for the options with a short description can be found at |Q_op|. per word depends very much on how similar the words are, that's why this tuning is complicated. - There are three numbers, separated by commas: + There are three numbers, separated by commas: > {start},{inc},{added} - +< For most languages the uncompressed word tree fits in memory. {start} gives the amount of memory in Kbyte that can be used before any compression is done. It should be a bit smaller than the amount of -- cgit From 17c59e417f818804187d85760765d51feb4d9c21 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sun, 25 Jun 2023 23:44:45 +0200 Subject: fix(docs): vimdoc syntax errors Prepare for https://github.com/neovim/tree-sitter-vimdoc/pull/108 which improves `{arg}` highlighting in many common cases: vim.foo({bar}) vim.foo( {bar}) nvim_foo({bar}) nvim_foo({bar},{baz}) nvim_foo({bar}, {baz}) foo[{buf}] The tradeoff is that things like `"[{"` are flagged as parse errors. We could avoid if we drop support for `foo[{buf}]`, but that is rather common (see `builtin.txt`). --- runtime/doc/options.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 7ef2195198..b5d0f6a6b7 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -901,7 +901,7 @@ A jump table for the options with a short description can be found at |Q_op|. accidentally overwriting existing files with a backup file. You might prefer using ".bak", but make sure that you don't have files with ".bak" that you want to keep. - Only normal file name characters can be used; "/\*?[|<>" are illegal. + Only normal file name characters can be used; `/\*?[|<>` are illegal. If you like to keep a lot of backups, you could use a BufWritePre autocommand to change 'backupext' just before writing the file to @@ -2445,7 +2445,7 @@ A jump table for the options with a short description can be found at |Q_op|. one dot may appear. This option is not copied to another buffer, independent of the 's' or 'S' flag in 'cpoptions'. - Only normal file name characters can be used, "/\*?[|<>" are illegal. + Only normal file name characters can be used, `/\*?[|<>` are illegal. *'fillchars'* *'fcs'* 'fillchars' 'fcs' string (default "") @@ -2650,7 +2650,7 @@ A jump table for the options with a short description can be found at |Q_op|. item commands ~ all any - block "(", "{", "[[", "[{", etc. + block (, {, [[, [{, etc. hor horizontal movements: "l", "w", "fx", etc. insert any command in Insert mode jump far jumps: "G", "gg", etc. @@ -3581,7 +3581,7 @@ A jump table for the options with a short description can be found at |Q_op|. Setting this option to a valid keymap name has the side effect of setting 'iminsert' to one, so that the keymap becomes effective. 'imsearch' is also set to one, unless it was -1 - Only normal file name characters can be used, "/\*?[|<>" are illegal. + Only normal file name characters can be used, `/\*?[|<>` are illegal. *'keymodel'* *'km'* 'keymodel' 'km' string (default "") @@ -3666,7 +3666,7 @@ A jump table for the options with a short description can be found at |Q_op|. matter what $LANG is set to: > :set langmenu=nl_NL.ISO_8859-1 < When 'langmenu' is empty, |v:lang| is used. - Only normal file name characters can be used, "/\*?[|<>" are illegal. + Only normal file name characters can be used, `/\*?[|<>` are illegal. If your $LANG is set to a non-English language but you do want to use the English menus: > :set langmenu=none @@ -4477,7 +4477,7 @@ A jump table for the options with a short description can be found at |Q_op|. Using 'patchmode' for compressed files appends the extension at the end (e.g., "file.gz.orig"), thus the resulting name isn't always recognized as a compressed file. - Only normal file name characters can be used, "/\*?[|<>" are illegal. + Only normal file name characters can be used, `/\*?[|<>` are illegal. *'path'* *'pa'* *E343* *E345* *E347* *E854* 'path' 'pa' string (default: ".,,") @@ -6259,7 +6259,7 @@ A jump table for the options with a short description can be found at |Q_op|. Syntax autocommand event is triggered with the value as argument. This option is not copied to another buffer, independent of the 's' or 'S' flag in 'cpoptions'. - Only normal file name characters can be used, "/\*?[|<>" are illegal. + Only normal file name characters can be used, `/\*?[|<>` are illegal. *'tabline'* *'tal'* 'tabline' 'tal' string (default empty) -- cgit From ab65a98adba4d32b03e7296529c4bf1491c783eb Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Tue, 27 Jun 2023 10:21:27 -0700 Subject: fix(docs): ignore_invalid #24174 Regex bug in scripts/gen_help_html.lua:ignore_invalid() --- runtime/doc/options.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index b5d0f6a6b7..da634966f9 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4444,7 +4444,8 @@ A jump table for the options with a short description can be found at |Q_op|. *'packpath'* *'pp'* 'packpath' 'pp' string (default: see 'runtimepath') - Directories used to find packages. See |packages| and |rtp-packages|. + Directories used to find packages. + See |packages| and |packages-runtimepath|. *'paragraphs'* *'para'* -- cgit From 881d17a11393da75a27c072faa3fd45f510175fe Mon Sep 17 00:00:00 2001 From: Lewis Russell Date: Mon, 17 Jul 2023 14:27:21 +0100 Subject: feat(options)!: remove compatible behaviours for vim 5.0 and earlier --- runtime/doc/options.txt | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index da634966f9..4b9797408c 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -762,13 +762,6 @@ A jump table for the options with a short description can be found at |Q_op|. When the value is empty, Vi compatible backspacing is used, none of the ways mentioned for the items above are possible. - For backwards compatibility with version 5.4 and earlier: - value effect ~ - 0 same as ":set backspace=" (Vi compatible) - 1 same as ":set backspace=indent,eol" - 2 same as ":set backspace=indent,eol,start" - 3 same as ":set backspace=indent,eol,nostop" - *'backup'* *'bk'* *'nobackup'* *'nobk'* 'backup' 'bk' boolean (default off) global @@ -880,8 +873,7 @@ A jump table for the options with a short description can be found at |Q_op|. - Careful with '\' characters, type one before a space, type two to get one in the option (see |option-backslash|), for example: > :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces -< - For backwards compatibility with Vim version 3.0 a '>' at the start - of the option is removed. +< See also 'backup' and 'writebackup' options. If you want to hide your backup files on Unix, consider this value: > :set backupdir=./.backup,~/.backup,.,/tmp @@ -2083,9 +2075,7 @@ A jump table for the options with a short description can be found at |Q_op|. - Careful with '\' characters, type one before a space, type two to get one in the option (see |option-backslash|), for example: > :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces -< - For backwards compatibility with Vim version 3.0 a '>' at the start - of the option is removed. - +< Editing the same file twice will result in a warning. Using "/tmp" on is discouraged: if the system crashes you lose the swap file. And others on the computer may be able to see the files. @@ -4490,10 +4480,6 @@ A jump table for the options with a short description can be found at |Q_op|. option may be relative or absolute. - Use commas to separate directory names: > :set path=.,/usr/local/include,/usr/include -< - Spaces can also be used to separate directory names (for backwards - compatibility with version 3.0). To have a space in a directory - name, precede it with an extra backslash, and escape the space: > - :set path=.,/dir/with\\\ space < - To include a comma in a directory name precede it with an extra backslash: > :set path=.,/dir/with\\,comma -- cgit From aaa151d506dffa01506619fbdf57537cd2318675 Mon Sep 17 00:00:00 2001 From: ii14 <59243201+ii14@users.noreply.github.com> Date: Tue, 25 Jul 2023 14:07:13 +0200 Subject: docs: remove trailing spaces #24455 --- runtime/doc/options.txt | 108 ++++++++++++++++++++++++------------------------ 1 file changed, 54 insertions(+), 54 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 4b9797408c..ee5e1f5589 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -2046,7 +2046,7 @@ A jump table for the options with a short description can be found at |Q_op|. Possible items: - The swap file will be created in the first directory where this is - possible. If it is not possible in any directory, but last + possible. If it is not possible in any directory, but last directory listed in the option does not exist, it is created. - Empty means that no swap file will be used (recovery is impossible!) and no |E303| error will be given. @@ -4830,7 +4830,7 @@ A jump table for the options with a short description can be found at |Q_op|. Defaults are setup to search these locations: 1. Your home directory, for personal preferences. Given by `stdpath("config")`. |$XDG_CONFIG_HOME| - 2. Directories which must contain configuration files according to + 2. Directories which must contain configuration files according to |xdg| ($XDG_CONFIG_DIRS, defaults to /etc/xdg). This also contains preferences from system administrator. 3. Data home directory, for plugins installed by user. @@ -5070,8 +5070,8 @@ A jump table for the options with a short description can be found at |Q_op|. % When included, save and restore the buffer list. If Vim is started with a file name argument, the buffer list is not restored. If Vim is started without a file name argument, the - buffer list is restored from the shada file. Quickfix - ('buftype'), unlisted ('buflisted'), unnamed and buffers on + buffer list is restored from the shada file. Quickfix + ('buftype'), unlisted ('buflisted'), unnamed and buffers on removable media (|shada-r|) are not saved. When followed by a number, the number specifies the maximum number of buffers that are stored. Without a number all @@ -5099,8 +5099,8 @@ A jump table for the options with a short description can be found at |Q_op|. @ Maximum number of items in the input-line history to be saved. When not included, the value of 'history' is used. *shada-c* - c Dummy option, kept for compatibility reasons. Has no actual - effect: ShaDa always uses UTF-8 and 'encoding' value is fixed + c Dummy option, kept for compatibility reasons. Has no actual + effect: ShaDa always uses UTF-8 and 'encoding' value is fixed to UTF-8 as well. *shada-f* f Whether file marks need to be stored. If zero, file marks ('0 @@ -5125,13 +5125,13 @@ A jump table for the options with a short description can be found at |Q_op|. could use "ra:,rb:". You can also use it for temp files, e.g., for Unix: "r/tmp". Case is ignored. *shada-s* - s Maximum size of an item contents in KiB. If zero then nothing - is saved. Unlike Vim this applies to all items, except for - the buffer list and header. Full item size is off by three - unsigned integers: with `s10` maximum item size may be 1 byte - (type: 7-bit integer) + 9 bytes (timestamp: up to 64-bit - integer) + 3 bytes (item size: up to 16-bit integer because - 2^8 < 10240 < 2^16) + 10240 bytes (requested maximum item + s Maximum size of an item contents in KiB. If zero then nothing + is saved. Unlike Vim this applies to all items, except for + the buffer list and header. Full item size is off by three + unsigned integers: with `s10` maximum item size may be 1 byte + (type: 7-bit integer) + 9 bytes (timestamp: up to 64-bit + integer) + 3 bytes (item size: up to 16-bit integer because + 2^8 < 10240 < 2^16) + 10240 bytes (requested maximum item contents size) = 10253 bytes. Example: > @@ -5141,7 +5141,7 @@ A jump table for the options with a short description can be found at |Q_op|. edited. <1000 Contents of registers (up to 1000 lines each) will be remembered. - s100 Items with contents occupying more then 100 KiB are + s100 Items with contents occupying more then 100 KiB are skipped. :0 Command-line history will not be saved. n~/nvim/shada The name of the file to use is "~/nvim/shada". @@ -5180,30 +5180,30 @@ A jump table for the options with a short description can be found at |Q_op|. If the name of the shell contains a space, you need to enclose it in quotes. Example with quotes: > :set shell=\"c:\program\ files\unix\sh.exe\"\ -f -< Note the backslash before each quote (to avoid starting a comment) and - each space (to avoid ending the option value), so better use |:let-&| +< Note the backslash before each quote (to avoid starting a comment) and + each space (to avoid ending the option value), so better use |:let-&| like this: > :let &shell='"C:\Program Files\unix\sh.exe" -f' -< Also note that the "-f" is not inside the quotes, because it is not +< Also note that the "-f" is not inside the quotes, because it is not part of the command name. *shell-unquoting* Rules regarding quotes: - 1. Option is split on space and tab characters that are not inside - quotes: "abc def" runs shell named "abc" with additional argument - "def", '"abc def"' runs shell named "abc def" with no additional - arguments (here and below: additional means “additional to + 1. Option is split on space and tab characters that are not inside + quotes: "abc def" runs shell named "abc" with additional argument + "def", '"abc def"' runs shell named "abc def" with no additional + arguments (here and below: additional means “additional to 'shellcmdflag'”). - 2. Quotes in option may be present in any position and any number: - '"abc"', '"a"bc', 'a"b"c', 'ab"c"' and '"a"b"c"' are all equivalent + 2. Quotes in option may be present in any position and any number: + '"abc"', '"a"bc', 'a"b"c', 'ab"c"' and '"a"b"c"' are all equivalent to just "abc". - 3. Inside quotes backslash preceding backslash means one backslash. - Backslash preceding quote means one quote. Backslash preceding - anything else means backslash and next character literally: - '"a\\b"' is the same as "a\b", '"a\\"b"' runs shell named literally + 3. Inside quotes backslash preceding backslash means one backslash. + Backslash preceding quote means one quote. Backslash preceding + anything else means backslash and next character literally: + '"a\\b"' is the same as "a\b", '"a\\"b"' runs shell named literally 'a"b', '"a\b"' is the same as "a\b" again. - 4. Outside of quotes backslash always means itself, it cannot be used + 4. Outside of quotes backslash always means itself, it cannot be used to escape quote: 'a\"b"' is the same as "a\b". - Note that such processing is done after |:set| did its own round of + Note that such processing is done after |:set| did its own round of unescaping, so to keep yourself sane use |:let-&| like shown above. *shell-powershell* To use PowerShell: > @@ -5226,7 +5226,7 @@ A jump table for the options with a short description can be found at |Q_op|. On Unix it can have more than one flag. Each white space separated part is passed as an argument to the shell command. See |option-backslash| about including spaces and backslashes. - See |shell-unquoting| which talks about separating this option into + See |shell-unquoting| which talks about separating this option into multiple arguments. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. @@ -6032,36 +6032,36 @@ A jump table for the options with a short description can be found at |Q_op|. ( - Start of item group. Can be used for setting the width and alignment of a section. Must be followed by %) somewhere. ) - End of item group. No width fields allowed. - T N For 'tabline': start of tab page N label. Use %T or %X to end - the label. Clicking this label with left mouse button switches + T N For 'tabline': start of tab page N label. Use %T or %X to end + the label. Clicking this label with left mouse button switches to the specified tab page. - X N For 'tabline': start of close tab N label. Use %X or %T to end - the label, e.g.: %3Xclose%X. Use %999X for a "close current - tab" label. Clicking this label with left mouse button closes + X N For 'tabline': start of close tab N label. Use %X or %T to end + the label, e.g.: %3Xclose%X. Use %999X for a "close current + tab" label. Clicking this label with left mouse button closes specified tab page. - @ N Start of execute function label. Use %X or %T to - end the label, e.g.: %10@SwitchBuffer@foo.c%X. Clicking this - label runs specified function: in the example when clicking once - using left mouse button on "foo.c" "SwitchBuffer(10, 1, 'l', - ' ')" expression will be run. Function receives the + @ N Start of execute function label. Use %X or %T to + end the label, e.g.: %10@SwitchBuffer@foo.c%X. Clicking this + label runs specified function: in the example when clicking once + using left mouse button on "foo.c" "SwitchBuffer(10, 1, 'l', + ' ')" expression will be run. Function receives the following arguments in order: 1. minwid field value or zero if no N was specified 2. number of mouse clicks to detect multiple clicks - 3. mouse button used: "l", "r" or "m" for left, right or middle - button respectively; one should not rely on third argument - being only "l", "r" or "m": any other non-empty string value - that contains only ASCII lower case letters may be expected + 3. mouse button used: "l", "r" or "m" for left, right or middle + button respectively; one should not rely on third argument + being only "l", "r" or "m": any other non-empty string value + that contains only ASCII lower case letters may be expected for other mouse buttons - 4. modifiers pressed: string which contains "s" if shift - modifier was pressed, "c" for control, "a" for alt and "m" - for meta; currently if modifier is not pressed string - contains space instead, but one should not rely on presence - of spaces or specific order of modifiers: use |stridx()| to - test whether some modifier is present; string is guaranteed - to contain only ASCII letters and spaces, one letter per - modifier; "?" modifier may also be present, but its presence - is a bug that denotes that new mouse button recognition was - added without modifying code that reacts on mouse clicks on + 4. modifiers pressed: string which contains "s" if shift + modifier was pressed, "c" for control, "a" for alt and "m" + for meta; currently if modifier is not pressed string + contains space instead, but one should not rely on presence + of spaces or specific order of modifiers: use |stridx()| to + test whether some modifier is present; string is guaranteed + to contain only ASCII letters and spaces, one letter per + modifier; "?" modifier may also be present, but its presence + is a bug that denotes that new mouse button recognition was + added without modifying code that reacts on mouse clicks on this label. Use |getmousepos()|.winid in the specified function to get the corresponding window id of the clicked item. -- cgit From 6fa17da39b270bf230764859a9537124b18d3ed5 Mon Sep 17 00:00:00 2001 From: Lewis Russell Date: Fri, 4 Aug 2023 21:26:53 +0100 Subject: docs(options): take ownership of options.txt (#24528) * docs(options): take ownership of options.txt - `src/nvim/options.lua` is now the source of truth - generate runtime/lua/vim/_meta/options.lua * fixup! zeer comments * fixup! zeer comments (2) * fixup! re-enable luacheck * fixup! regen --- runtime/doc/options.txt | 752 ++++++++++++++++++++++++------------------------ 1 file changed, 371 insertions(+), 381 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index ee5e1f5589..70329a170a 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -584,7 +584,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'revins'. *'ambiwidth'* *'ambw'* -'ambiwidth' 'ambw' string (default: "single") +'ambiwidth' 'ambw' string (default "single") global Tells Vim what to do with characters with East Asian Width Class Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek @@ -617,18 +617,8 @@ A jump table for the options with a short description can be found at |Q_op|. set to one of CJK locales. See Unicode Standard Annex #11 (https://www.unicode.org/reports/tr11). - *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* -'autochdir' 'acd' boolean (default off) - global - When on, Vim will change the current working directory whenever you - open a file, switch buffers, delete a buffer or open/close a window. - It will change to the directory containing the file which was opened - or selected. When a buffer has no name it also has no directory, thus - the current directory won't change when navigating to it. - Note: When this option is on some plugins may not work. - *'arabic'* *'arab'* *'noarabic'* *'noarab'* -'arabic' 'arab' boolean (default off) +'arabic' 'arab' boolean (default off) local to window This option can be set to start editing Arabic text. Setting this option will: @@ -645,9 +635,8 @@ A jump table for the options with a short description can be found at |Q_op|. option). Also see |arabic.txt|. - *'arabicshape'* *'arshape'* - *'noarabicshape'* *'noarshape'* -'arabicshape' 'arshape' boolean (default on) + *'arabicshape'* *'arshape'* *'noarabicshape'* *'noarshape'* +'arabicshape' 'arshape' boolean (default on) global When on and 'termbidi' is off, the required visual character corrections that need to take place for displaying the Arabic language @@ -662,6 +651,16 @@ A jump table for the options with a short description can be found at |Q_op|. Arabic is a complex language which requires other settings, for further details see |arabic.txt|. + *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* +'autochdir' 'acd' boolean (default off) + global + When on, Vim will change the current working directory whenever you + open a file, switch buffers, delete a buffer or open/close a window. + It will change to the directory containing the file which was opened + or selected. When a buffer has no name it also has no directory, thus + the current directory won't change when navigating to it. + Note: When this option is on some plugins may not work. + *'autoindent'* *'ai'* *'noautoindent'* *'noai'* 'autoindent' 'ai' boolean (default on) local to buffer @@ -677,7 +676,7 @@ A jump table for the options with a short description can be found at |Q_op|. When 'smartindent' or 'cindent' is on the indent is changed in a different way. - *'autoread'* *'ar'* *'noautoread'* *'noar'* + *'autoread'* *'ar'* *'noautoread'* *'noar'* 'autoread' 'ar' boolean (default on) global or local to buffer |global-local| When a file has been detected to have been changed outside of Vim and @@ -689,7 +688,8 @@ A jump table for the options with a short description can be found at |Q_op|. using the global value: > :set autoread< < - *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* + + *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* 'autowrite' 'aw' boolean (default off) global Write the contents of the file, if it has been modified, on each @@ -707,7 +707,7 @@ A jump table for the options with a short description can be found at |Q_op|. don't want to be saved this option may cause it to be saved anyway. Renaming the buffer with ":file {name}" may help avoid this. - *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* + *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* 'autowriteall' 'awa' boolean (default off) global Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", @@ -715,7 +715,7 @@ A jump table for the options with a short description can be found at |Q_op|. Setting this option also implies that Vim behaves like 'autowrite' has been set. - *'background'* *'bg'* + *'background'* *'bg'* 'background' 'bg' string (default "dark") global When set to "dark" or "light", adjusts the default color groups for @@ -745,7 +745,7 @@ A jump table for the options with a short description can be found at |Q_op|. option, you must load syntax.vim again to see the result. This can be done with ":syntax on". - *'backspace'* *'bs'* + *'backspace'* *'bs'* 'backspace' 'bs' string (default "indent,eol,start") global Influences the working of , , CTRL-W and CTRL-U in Insert @@ -777,7 +777,7 @@ A jump table for the options with a short description can be found at |Q_op|. oldest version of a file. *'backupcopy'* *'bkc'* -'backupcopy' 'bkc' string (default: "auto") +'backupcopy' 'bkc' string (default "auto") global or local to buffer |global-local| When writing a file and a backup is made, this option tells how it's done. This is a comma-separated list of words. @@ -885,7 +885,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'backupext'* *'bex'* *E589* + *'backupext'* *'bex'* *E589* 'backupext' 'bex' string (default "~") global String which is appended to a file name to make the name of the @@ -902,9 +902,9 @@ A jump table for the options with a short description can be found at |Q_op|. < Use 'backupdir' to put the backup in a different directory. *'backupskip'* *'bsk'* -'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*" - Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*" - Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") +'backupskip' 'bsk' string (default "$TMPDIR/*,$TMP/*,$TEMP/*" + Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*" + Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")) global A list of file patterns. When one of the patterns matches with the name of the file which is written, no backup file is created. Both @@ -965,7 +965,7 @@ A jump table for the options with a short description can be found at |Q_op|. indicate that an error occurred. It can be silenced by adding the "error" keyword. - *'binary'* *'bin'* *'nobinary'* *'nobin'* + *'binary'* *'bin'* *'nobinary'* *'nobin'* 'binary' 'bin' boolean (default off) local to buffer This option should be set before editing a binary file. You can also @@ -995,7 +995,7 @@ A jump table for the options with a short description can be found at |Q_op|. the last line if there is none; this would make the file longer). See the 'endofline' option. - *'bomb'* *'nobomb'* + *'bomb'* *'nobomb'* 'bomb' boolean (default off) local to buffer When writing a file and the following conditions are met, a BOM (Byte @@ -1021,14 +1021,14 @@ A jump table for the options with a short description can be found at |Q_op|. break if 'linebreak' is on. Only works for ASCII characters. *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* -'breakindent' 'bri' boolean (default off) +'breakindent' 'bri' boolean (default off) local to window Every wrapped line will continue visually indented (same amount of space as the beginning of that line), thus preserving horizontal blocks of text. - *'breakindentopt'* *'briopt'* -'breakindentopt' 'briopt' string (default empty) + *'breakindentopt'* *'briopt'* +'breakindentopt' 'briopt' string (default "") local to window Settings for 'breakindent'. It can consist of the following optional items and must be separated by a comma: @@ -1059,7 +1059,7 @@ A jump table for the options with a short description can be found at |Q_op|. (default: off) *'browsedir'* *'bsdir'* -'browsedir' 'bsdir' string (default: "last") +'browsedir' 'bsdir' string (default "last") global Which directory to use for the file browser: last Use same directory as with last file browser, where a @@ -1069,7 +1069,7 @@ A jump table for the options with a short description can be found at |Q_op|. {path} Use the specified directory *'bufhidden'* *'bh'* -'bufhidden' 'bh' string (default: "") +'bufhidden' 'bh' string (default "") local to buffer This option specifies what happens when a buffer is no longer displayed in a window: @@ -1092,7 +1092,7 @@ A jump table for the options with a short description can be found at |Q_op|. special kinds of buffers. See |special-buffers|. *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* -'buflisted' 'bl' boolean (default: on) +'buflisted' 'bl' boolean (default on) local to buffer When this option is set, the buffer shows up in the buffer list. If it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. @@ -1101,7 +1101,7 @@ A jump table for the options with a short description can be found at |Q_op|. But not when moving to a buffer with ":buffer". *'buftype'* *'bt'* *E382* -'buftype' 'bt' string (default: "") +'buftype' 'bt' string (default "") local to buffer The value of this option specifies the type of a buffer: normal buffer @@ -1149,7 +1149,7 @@ A jump table for the options with a short description can be found at |Q_op|. |FileWriteCmd| or |FileAppendCmd| autocommands. *'casemap'* *'cmp'* -'casemap' 'cmp' string (default: "internal,keepascii") +'casemap' 'cmp' string (default "internal,keepascii") global Specifies details about changing the case of letters. It may contain these words, separated by a comma: @@ -1162,15 +1162,15 @@ A jump table for the options with a short description can be found at |Q_op|. This probably only matters for Turkish. *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'* -'cdhome' 'cdh' boolean (default: off) +'cdhome' 'cdh' boolean (default off) global When on, |:cd|, |:tcd| and |:lcd| without an argument changes the current working directory to the |$HOME| directory like in Unix. When off, those commands just print the current directory name. On Unix this option has no effect. - *'cdpath'* *'cd'* *E344* *E346* -'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") + *'cdpath'* *'cd'* *E344* *E346* +'cdpath' 'cd' string (default equivalent to $CDPATH or ",,") global This is a list of directories which will be searched when using the |:cd|, |:tcd| and |:lcd| commands, provided that the directory being @@ -1188,8 +1188,8 @@ A jump table for the options with a short description can be found at |Q_op|. security reasons. (parts of 'cdpath' can be passed to the shell to expand file names). - *'cedit'* -'cedit' string (default: CTRL-F) + *'cedit'* +'cedit' string (default CTRL-F) global The key used in Command-line Mode to open the command-line window. Only non-printable keys are allowed. @@ -1200,15 +1200,15 @@ A jump table for the options with a short description can be found at |Q_op|. < |Nvi| also has this option, but it only uses the first character. See |cmdwin|. - *'channel'* -'channel' number (default: 0) + *'channel'* +'channel' number (default 0) local to buffer |channel| connected to the buffer, or 0 if no channel is connected. In a |:terminal| buffer this is the terminal channel. Read-only. *'charconvert'* *'ccv'* *E202* *E214* *E513* -'charconvert' 'ccv' string (default "") +'charconvert' 'ccv' string (default "") global An expression that is used for character encoding conversion. It is evaluated when a file that is to be read or has been written has a @@ -1243,7 +1243,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'cindent'* *'cin'* *'nocindent'* *'nocin'* + *'cindent'* *'cin'* *'nocindent'* *'nocin'* 'cindent' 'cin' boolean (default off) local to buffer Enables automatic C program indenting. See 'cinkeys' to set the keys @@ -1257,7 +1257,7 @@ A jump table for the options with a short description can be found at |Q_op|. When you don't like the way 'cindent' works, try the 'smartindent' option or 'indentexpr'. - *'cinkeys'* *'cink'* + *'cinkeys'* *'cink'* 'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e") local to buffer A list of keys that, when typed in Insert mode, cause reindenting of @@ -1273,6 +1273,14 @@ A jump table for the options with a short description can be found at |Q_op|. program. See |cinoptions-values| for the values of this option, and |C-indenting| for info on C indenting in general. + *'cinscopedecls'* *'cinsd'* +'cinscopedecls' 'cinsd' string (default "public,protected,private") + local to buffer + Keywords that are interpreted as a C++ scope declaration by |cino-g|. + Useful e.g. for working with the Qt framework that defines additional + scope declarations "signals", "public slots" and "private slots": > + set cinscopedecls+=signals,public\ slots,private\ slots +< *'cinwords'* *'cinw'* 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") @@ -1284,15 +1292,7 @@ A jump table for the options with a short description can be found at |Q_op|. matter, include the keyword both the uppercase and lowercase: "if,If,IF". - *'cinscopedecls'* *'cinsd'* -'cinscopedecls' 'cinsd' string (default "public,protected,private") - local to buffer - Keywords that are interpreted as a C++ scope declaration by |cino-g|. - Useful e.g. for working with the Qt framework that defines additional - scope declarations "signals", "public slots" and "private slots": > - set cinscopedecls+=signals,public\ slots,private\ slots - -< *'clipboard'* *'cb'* + *'clipboard'* *'cb'* 'clipboard' 'cb' string (default "") global This option is a list of comma-separated names. @@ -1320,7 +1320,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'cmdheight'* *'ch'* 'cmdheight' 'ch' number (default 1) - global or local to tab page + global or local to tab page |global-local| Number of screen lines to use for the command-line. Helps avoiding |hit-enter| prompts. The value of this option is stored with the tab page, so that each tab @@ -1374,8 +1374,7 @@ A jump table for the options with a short description can be found at |Q_op|. < Minimum value is 12, maximum value is 10000. *'comments'* *'com'* *E524* *E525* -'comments' 'com' string (default - "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") +'comments' 'com' string (default "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") local to buffer A comma-separated list of strings that can start a comment line. See |format-comments|. See |option-backslash| about using backslashes to @@ -1389,7 +1388,7 @@ A jump table for the options with a short description can be found at |Q_op|. add markers for folding, see |fold-marker|. *'complete'* *'cpt'* *E535* -'complete' 'cpt' string (default: ".,w,b,u,t") +'complete' 'cpt' string (default ".,w,b,u,t") local to buffer This option specifies how keyword completion |ins-completion| works when CTRL-P or CTRL-N are used. It is also used for whole-line @@ -1424,7 +1423,7 @@ A jump table for the options with a short description can be found at |Q_op|. |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). *'completefunc'* *'cfu'* -'completefunc' 'cfu' string (default: empty) +'completefunc' 'cfu' string (default "") local to buffer This option specifies a function to be used for Insert mode completion with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| @@ -1435,23 +1434,8 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'completeslash'* *'csl'* -'completeslash' 'csl' string (default: "") - local to buffer - only for MS-Windows - When this option is set it overrules 'shellslash' for completion: - - When this option is set to "slash", a forward slash is used for path - completion in insert mode. This is useful when editing HTML tag, or - Makefile with 'noshellslash' on MS-Windows. - - When this option is set to "backslash", backslash is used. This is - useful when editing a batch file with 'shellslash' set on MS-Windows. - - When this option is empty, same character is used as for - 'shellslash'. - For Insert mode completion the buffer-local value is used. For - command line completion the global value is used. - *'completeopt'* *'cot'* -'completeopt' 'cot' string (default: "menu,preview") +'completeopt' 'cot' string (default "menu,preview") global A comma-separated list of options for Insert mode completion |ins-completion|. The supported values are: @@ -1482,9 +1466,23 @@ A jump table for the options with a short description can be found at |Q_op|. select one from the menu. Only works in combination with "menu" or "menuone". + *'completeslash'* *'csl'* +'completeslash' 'csl' string (default "") + local to buffer + only for MS-Windows + When this option is set it overrules 'shellslash' for completion: + - When this option is set to "slash", a forward slash is used for path + completion in insert mode. This is useful when editing HTML tag, or + Makefile with 'noshellslash' on MS-Windows. + - When this option is set to "backslash", backslash is used. This is + useful when editing a batch file with 'shellslash' set on MS-Windows. + - When this option is empty, same character is used as for + 'shellslash'. + For Insert mode completion the buffer-local value is used. For + command line completion the global value is used. - *'concealcursor'* *'cocu'* -'concealcursor' 'cocu' string (default: "") + *'concealcursor'* *'cocu'* +'concealcursor' 'cocu' string (default "") local to window Sets the modes in which text in the cursor line can also be concealed. When the current mode is listed then concealing happens just like in @@ -1502,9 +1500,8 @@ A jump table for the options with a short description can be found at |Q_op|. Keep in mind that the cursor position is not always where it's displayed. E.g., when moving vertically it may change column. - *'conceallevel'* *'cole'* -'conceallevel' 'cole' number (default 0) +'conceallevel' 'cole' number (default 0) local to window Determine how text with the "conceal" syntax attribute |:syn-conceal| is shown: @@ -1526,7 +1523,7 @@ A jump table for the options with a short description can be found at |Q_op|. option. *'confirm'* *'cf'* *'noconfirm'* *'nocf'* -'confirm' 'cf' boolean (default off) +'confirm' 'cf' boolean (default off) global When 'confirm' is on, certain operations that would normally fail because of unsaved changes to a buffer, e.g. ":q" and ":e", @@ -1551,7 +1548,7 @@ A jump table for the options with a short description can be found at |Q_op|. See 'preserveindent'. *'cpoptions'* *'cpo'* *cpo* -'cpoptions' 'cpo' string (default: "aABceFs_") +'cpoptions' 'cpo' string (default "aABceFs_") global A sequence of single character flags. When a character is present this indicates Vi-compatible behavior. This is used for things where @@ -1785,7 +1782,7 @@ A jump table for the options with a short description can be found at |Q_op|. whitespace following the word in the motion. *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* -'cursorbind' 'crb' boolean (default off) +'cursorbind' 'crb' boolean (default off) local to window When this option is set, as the cursor in the current window moves other cursorbound windows (windows that also have @@ -1795,7 +1792,6 @@ A jump table for the options with a short description can be found at |Q_op|. inserted and deleted lines (though not characters within a line) are taken into account. - *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* 'cursorcolumn' 'cuc' boolean (default off) local to window @@ -1816,9 +1812,8 @@ A jump table for the options with a short description can be found at |Q_op|. When Visual mode is active the highlighting isn't used to make it easier to see the selected text. - - *'cursorlineopt'* *'culopt'* -'cursorlineopt' 'culopt' string (default: "number,line") + *'cursorlineopt'* *'culopt'* +'cursorlineopt' 'culopt' string (default "both") local to window Comma-separated list of settings for how 'cursorline' is displayed. Valid values: @@ -1834,8 +1829,7 @@ A jump table for the options with a short description can be found at |Q_op|. "line" and "screenline" cannot be used together. - - *'debug'* + *'debug'* 'debug' string (default "") global These values can be used: @@ -1873,7 +1867,7 @@ A jump table for the options with a short description can be found at |Q_op|. < *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* -'delcombine' 'deco' boolean (default off) +'delcombine' 'deco' boolean (default off) global If editing Unicode and this option is set, backspace and Normal mode "x" delete each combining character on its own. When it is off (the @@ -1911,13 +1905,13 @@ A jump table for the options with a short description can be found at |Q_op|. uses another default. Backticks cannot be used in this option for security reasons. - *'diff'* *'nodiff'* + *'diff'* *'nodiff'* 'diff' boolean (default off) local to window Join the current window in the group of windows that shows differences between files. See |diff-mode|. - *'dex'* *'diffexpr'* + *'diffexpr'* *'dex'* 'diffexpr' 'dex' string (default "") global Expression which is evaluated to obtain a diff file (either ed-style @@ -1925,7 +1919,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'dip'* *'diffopt'* + *'diffopt'* *'dip'* 'diffopt' 'dip' string (default "internal,filler,closeoff") global Option settings for diff mode. It can consist of the following items. @@ -2018,7 +2012,7 @@ A jump table for the options with a short description can be found at |Q_op|. hunks of up to 30 lines each, or a 3 buffer diff with hunks of up to 20 lines each. - algorithm:{text} Use the specified diff algorithm with the + algorithm:{text} Use the specified diff algorithm with the internal diff engine. Currently supported algorithms are: myers the default algorithm @@ -2033,7 +2027,8 @@ A jump table for the options with a short description can be found at |Q_op|. :set diffopt=internal,filler,foldcolumn:3 :set diffopt-=internal " do NOT use the internal diff parser < - *'digraph'* *'dg'* *'nodigraph'* *'nodg'* + + *'digraph'* *'dg'* *'nodigraph'* *'nodg'* 'digraph' 'dg' boolean (default off) global Enable the entering of digraphs in Insert mode with {char1} @@ -2085,7 +2080,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'display'* *'dy'* + *'display'* *'dy'* 'display' 'dy' string (default "lastline") global Change the way text is displayed. This is a comma-separated list of @@ -2114,8 +2109,8 @@ A jump table for the options with a short description can be found at |Q_op|. hor horizontally, height of windows is not affected both width and height of windows is affected - *'emoji'* *'emo'* *'noemoji'* *'noemo'* -'emoji' 'emo' boolean (default: on) + *'emoji'* *'emo'* *'noemoji'* *'noemo'* +'emoji' 'emo' boolean (default on) global When on all Unicode emoji characters are considered to be full width. This excludes "text emoji" characters, which are normally displayed as @@ -2123,8 +2118,9 @@ A jump table for the options with a short description can be found at |Q_op|. and it has been determined on trial-and-error basis. Use the |setcellwidths()| function to change the behavior. - *'encoding'* *'enc'* *E543* -'encoding' 'enc' + *'encoding'* *'enc'* +'encoding' 'enc' string (default "utf-8") + global String-encoding used internally and for |RPC| communication. Always UTF-8. @@ -2156,7 +2152,7 @@ A jump table for the options with a short description can be found at |Q_op|. be kept. But you can change it if you want to. See |eol-and-eof| for example settings. - *'equalalways'* *'ea'* *'noequalalways'* *'noea'* + *'equalalways'* *'ea'* *'noequalalways'* *'noea'* 'equalalways' 'ea' boolean (default on) global When on, all the windows are automatically made the same size after @@ -2195,7 +2191,7 @@ A jump table for the options with a short description can be found at |Q_op|. or do nothing. See 'belloff' to finetune when to ring the bell. *'errorfile'* *'ef'* -'errorfile' 'ef' string (default: "errors.err") +'errorfile' 'ef' string (default "errors.err") global Name of the errorfile for the QuickFix mode (see |:cf|). When the "-q" command-line argument is used, 'errorfile' is set to the @@ -2221,7 +2217,8 @@ A jump table for the options with a short description can be found at |Q_op|. Otherwise this is a comma-separated list of event names. Example: > :set ei=WinEnter,WinLeave < - *'expandtab'* *'et'* *'noexpandtab'* *'noet'* + + *'expandtab'* *'et'* *'noexpandtab'* *'noet'* 'expandtab' 'et' boolean (default off) local to buffer In Insert mode: Use the appropriate number of spaces to insert a @@ -2230,7 +2227,7 @@ A jump table for the options with a short description can be found at |Q_op|. on, use CTRL-V. See also |:retab| and |ins-expandtab|. *'exrc'* *'ex'* *'noexrc'* *'noex'* -'exrc' 'ex' boolean (default off) +'exrc' 'ex' boolean (default off) global Automatically execute .nvim.lua, .nvimrc, and .exrc files in the current directory, if the file is in the |trust| list. Use |:trust| to @@ -2243,8 +2240,8 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'fileencoding'* *'fenc'* *E213* -'fileencoding' 'fenc' string (default: "") + *'fileencoding'* *'fenc'* *E213* +'fileencoding' 'fenc' string (default "") local to buffer File-content encoding for the current buffer. Conversion is done with iconv() or as specified with 'charconvert'. @@ -2285,7 +2282,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be changed when 'modifiable' is off. *'fileencodings'* *'fencs'* -'fileencodings' 'fencs' string (default: "ucs-bom,utf-8,default,latin1") +'fileencodings' 'fencs' string (default "ucs-bom,utf-8,default,latin1") global This is a list of character encodings considered when starting to edit an existing file. When a file is read, Vim tries to use the first @@ -2334,9 +2331,8 @@ A jump table for the options with a short description can be found at |Q_op|. Setting this option does not have an effect until the next time a file is read. - *'fileformat'* *'ff'* -'fileformat' 'ff' string (Windows default: "dos", - Unix default: "unix") + *'fileformat'* *'ff'* +'fileformat' 'ff' string (default Windows: "dos", Unix: "unix") local to buffer This gives the of the current buffer, which is used for reading/writing the buffer from/to a file: @@ -2354,10 +2350,8 @@ A jump table for the options with a short description can be found at |Q_op|. option is set, because the file would be different when written. This option cannot be changed when 'modifiable' is off. - *'fileformats'* *'ffs'* -'fileformats' 'ffs' string (default: - Win32: "dos,unix", - Unix: "unix,dos") + *'fileformats'* *'ffs'* +'fileformats' 'ffs' string (default Windows: "dos,unix", Unix: "unix,dos") global This gives the end-of-line () formats that will be tried when starting to edit a new buffer and when reading a file into an existing @@ -2407,13 +2401,13 @@ A jump table for the options with a short description can be found at |Q_op|. *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* 'fileignorecase' 'fic' boolean (default on for systems where case in file - names is normally ignored) + names is normally ignored) global When set case is ignored when using file names and directories. See 'wildignorecase' for only ignoring case when doing completion. - *'filetype'* *'ft'* -'filetype' 'ft' string (default: "") + *'filetype'* *'ft'* +'filetype' 'ft' string (default "") local to buffer When this option is set, the FileType autocommand event is triggered. All autocommands that match with the value of this option will be @@ -2516,25 +2510,25 @@ A jump table for the options with a short description can be found at |Q_op|. See |eol-and-eof| for example settings. *'foldclose'* *'fcl'* -'foldclose' 'fcl' string (default "") +'foldclose' 'fcl' string (default "") global When set to "all", a fold is closed when the cursor isn't in it and its level is higher than 'foldlevel'. Useful if you want folds to automatically close when moving out of them. *'foldcolumn'* *'fdc'* -'foldcolumn' 'fdc' string (default "0") +'foldcolumn' 'fdc' string (default "0") local to window When and how to draw the foldcolumn. Valid values are: "auto": resize to the minimum amount of folds to display. "auto:[1-9]": resize to accommodate multiple folds up to the selected level - 0: to disable foldcolumn + 0: to disable foldcolumn "[1-9]": to display a fixed number of columns See |folding|. *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* -'foldenable' 'fen' boolean (default on) +'foldenable' 'fen' boolean (default on) local to window When off, all folds are open. This option can be used to quickly switch between showing all text unfolded and viewing the text with @@ -2545,7 +2539,7 @@ A jump table for the options with a short description can be found at |Q_op|. See |folding|. *'foldexpr'* *'fde'* -'foldexpr' 'fde' string (default: "0") +'foldexpr' 'fde' string (default "0") local to window The expression used for when 'foldmethod' is "expr". It is evaluated for each line to obtain its fold level. The context is set to the @@ -2561,7 +2555,7 @@ A jump table for the options with a short description can be found at |Q_op|. evaluating 'foldexpr' |textlock|. *'foldignore'* *'fdi'* -'foldignore' 'fdi' string (default: "#") +'foldignore' 'fdi' string (default "#") local to window Used only when 'foldmethod' is "indent". Lines starting with characters in 'foldignore' will get their fold level from surrounding @@ -2569,7 +2563,7 @@ A jump table for the options with a short description can be found at |Q_op|. The default "#" works well for C programs. See |fold-indent|. *'foldlevel'* *'fdl'* -'foldlevel' 'fdl' number (default: 0) +'foldlevel' 'fdl' number (default 0) local to window Sets the fold level: Folds with a higher level will be closed. Setting this option to zero will close all folds. Higher numbers will @@ -2577,8 +2571,8 @@ A jump table for the options with a short description can be found at |Q_op|. This option is set by commands like |zm|, |zM| and |zR|. See |fold-foldlevel|. - *'foldlevelstart'* *'fdls'* -'foldlevelstart' 'fdls' number (default: -1) + *'foldlevelstart'* *'fdls'* +'foldlevelstart' 'fdls' number (default -1) global Sets 'foldlevel' when starting to edit another buffer in a window. Useful to always start editing with all folds closed (value zero), @@ -2590,8 +2584,8 @@ A jump table for the options with a short description can be found at |Q_op|. overrule the 'foldlevel' value for specific files. When the value is negative, it is not used. - *'foldmarker'* *'fmr'* *E536* -'foldmarker' 'fmr' string (default: "{{{,}}}") + *'foldmarker'* *'fmr'* *E536* +'foldmarker' 'fmr' string (default "{{{,}}}") local to window The start and end marker used when 'foldmethod' is "marker". There must be one comma, which separates the start and end marker. The @@ -2599,7 +2593,7 @@ A jump table for the options with a short description can be found at |Q_op|. See |fold-marker|. *'foldmethod'* *'fdm'* -'foldmethod' 'fdm' string (default: "manual") +'foldmethod' 'fdm' string (default "manual") local to window The kind of folding used for the current window. Possible values: |fold-manual| manual Folds are created manually. @@ -2610,7 +2604,7 @@ A jump table for the options with a short description can be found at |Q_op|. |fold-diff| diff Fold text that is not changed. *'foldminlines'* *'fml'* -'foldminlines' 'fml' number (default: 1) +'foldminlines' 'fml' number (default 1) local to window Sets the number of screen lines above which a fold can be displayed closed. Also for manually closed folds. With the default value of @@ -2621,15 +2615,14 @@ A jump table for the options with a short description can be found at |Q_op|. than 'foldminlines', a following "zc" may close a containing fold. *'foldnestmax'* *'fdn'* -'foldnestmax' 'fdn' number (default: 20) +'foldnestmax' 'fdn' number (default 20) local to window Sets the maximum nesting of folds for the "indent" and "syntax" methods. This avoids that too many folds will be created. Using more than 20 doesn't work, because the internal limit is 20. *'foldopen'* *'fdo'* -'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, - search,tag,undo") +'foldopen' 'fdo' string (default "block,hor,mark,percent,quickfix,search,tag,undo") global Specifies for which type of commands folds will be opened, if the command moves the cursor into a closed fold. It is a comma-separated @@ -2663,7 +2656,7 @@ A jump table for the options with a short description can be found at |Q_op|. set the 'foldclose' option to "all". *'foldtext'* *'fdt'* -'foldtext' 'fdt' string (default: "foldtext()") +'foldtext' 'fdt' string (default "foldtext()") local to window An expression which is used to specify the text displayed for a closed fold. The context is set to the script where 'foldexpr' was set, @@ -2678,7 +2671,7 @@ A jump table for the options with a short description can be found at |Q_op|. evaluating 'foldtext' |textlock|. *'formatexpr'* *'fex'* -'formatexpr' 'fex' string (default "") +'formatexpr' 'fex' string (default "") local to buffer Expression which is evaluated to format a range of lines for the |gq| operator or automatic formatting (see 'formatoptions'). When this @@ -2718,8 +2711,8 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set in a modeline when 'modelineexpr' is off. NOTE: This option is set to "" when 'compatible' is set. - *'formatlistpat'* *'flp'* -'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") + *'formatlistpat'* *'flp'* +'formatlistpat' 'flp' string (default "^\s*\d\+[\]:.)}\t ]\s*") local to buffer A pattern that is used to recognize a list header. This is used for the "n" flag in 'formatoptions'. @@ -2731,8 +2724,8 @@ A jump table for the options with a short description can be found at |Q_op|. The default recognizes a number, followed by an optional punctuation character and white space. - *'formatoptions'* *'fo'* -'formatoptions' 'fo' string (default: "tcqj") + *'formatoptions'* *'fo'* +'formatoptions' 'fo' string (default "tcqj") local to buffer This is a sequence of letters which describes how automatic formatting is to be done. See |fo-table|. Commas can be inserted for @@ -2741,7 +2734,7 @@ A jump table for the options with a short description can be found at |Q_op|. "+=" and "-=" feature of ":set" |add-option-flags|. *'formatprg'* *'fp'* -'formatprg' 'fp' string (default "") +'formatprg' 'fp' string (default "") global or local to buffer |global-local| The name of an external program that will be used to format the lines selected with the |gq| operator. The program must take the input on @@ -2773,7 +2766,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* + *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* 'gdefault' 'gd' boolean (default off) global When on, the ":substitute" flag 'g' is default on. This means that @@ -2799,7 +2792,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'grepprg'* *'gp'* 'grepprg' 'gp' string (default "grep -n ", - Unix: "grep -n $* /dev/null") + Unix: "grep -n $* /dev/null") global or local to buffer |global-local| Program to use for the |:grep| command. This option may contain '%' and '#' characters, which are expanded like when used in a command- @@ -2817,7 +2810,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* + *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* 'guicursor' 'gcr' string (default "n-v-c-sm:block,i-ci-ve:ver25,r-cr-o:hor20") global Configures the cursor style for each mode. Works in the GUI and many @@ -2903,8 +2896,8 @@ A jump table for the options with a short description can be found at |Q_op|. :highlight Cursor gui=reverse guifg=NONE guibg=NONE :highlight Cursor gui=NONE guifg=bg guibg=fg < - *'guifont'* *'gfn'* - *E235* *E596* + + *'guifont'* *'gfn'* *E235* *E596* 'guifont' 'gfn' string (default "") global This is a list of fonts which will be used for the GUI version of Vim. @@ -2964,6 +2957,7 @@ A jump table for the options with a short description can be found at |Q_op|. :set guifont=courier_new:h12:w5:b:cRUSSIAN :set guifont=Andale_Mono:h7.5:w4.5 < + *'guifontwide'* *'gfw'* *E231* *E533* *E534* 'guifontwide' 'gfw' string (default "") global @@ -3079,7 +3073,7 @@ A jump table for the options with a short description can be found at |Q_op|. removing GUI components. *'guitablabel'* *'gtl'* -'guitablabel' 'gtl' string (default empty) +'guitablabel' 'gtl' string (default "") global When non-empty describes the text to use in a label of the GUI tab pages line. When empty and when the result is empty Vim will use a @@ -3096,7 +3090,7 @@ A jump table for the options with a short description can be found at |Q_op|. used. *'guitabtooltip'* *'gtt'* -'guitabtooltip' 'gtt' string (default empty) +'guitabtooltip' 'gtt' string (default "") global When non-empty describes the text to use in a tooltip for the GUI tab pages line. When empty Vim will use a default tooltip. @@ -3107,7 +3101,8 @@ A jump table for the options with a short description can be found at |Q_op|. *'helpfile'* *'hf'* 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt" - (others) "$VIMRUNTIME/doc/help.txt") + (others) "$VIMRUNTIME/doc/help.txt") + ) global Name of the main help file. All distributed help files should be placed together in one directory. Additionally, all "doc" directories @@ -3129,7 +3124,7 @@ A jump table for the options with a short description can be found at |Q_op|. set to 'helpheight'. Set to zero to disable. *'helplang'* *'hlg'* -'helplang' 'hlg' string (default: messages language or empty) +'helplang' 'hlg' string (default messages language or empty) global Comma-separated list of languages. Vim will use the first language for which the desired help can be found. The English help will always @@ -3144,7 +3139,7 @@ A jump table for the options with a short description can be found at |Q_op|. try to find the tag in the current language before using this option. See |help-translated|. - *'hidden'* *'hid'* *'nohidden'* *'nohid'* + *'hidden'* *'hid'* *'nohidden'* *'nohid'* 'hidden' 'hid' boolean (default on) global When off a buffer is unloaded (including loss of undo information) @@ -3163,14 +3158,14 @@ A jump table for the options with a short description can be found at |Q_op|. 'hidden' is set for one command with ":hide {command}" |:hide|. *'history'* *'hi'* -'history' 'hi' number (default: 10000) +'history' 'hi' number (default 10000) global A history of ":" commands, and a history of previous search patterns is remembered. This option decides how many entries may be stored in each of these histories (see |cmdline-editing|). The maximum value is 10000. - *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* + *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* 'hlsearch' 'hls' boolean (default on) global When there is a previous search pattern, highlight all its matches. @@ -3202,7 +3197,7 @@ A jump table for the options with a short description can be found at |Q_op|. Overridden by the 'iconstring' option. Only works if the terminal supports setting window icons. - *'iconstring'* + *'iconstring'* 'iconstring' string (default "") global When this option is not empty, it will be used for the icon text of @@ -3222,8 +3217,8 @@ A jump table for the options with a short description can be found at |Q_op|. Can be overruled by using "\c" or "\C" in the pattern, see |/ignorecase|. - *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* -'imcmdline' 'imc' boolean (default off) + *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* +'imcmdline' 'imc' boolean (default off) global When set the Input Method is always on when starting to edit a command line, unless entering a search pattern (see 'imsearch' for that). @@ -3231,8 +3226,8 @@ A jump table for the options with a short description can be found at |Q_op|. English characters directly, e.g., when it's used to type accented characters with dead keys. - *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* -'imdisable' 'imd' boolean (default off, on for some systems (SGI)) + *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* +'imdisable' 'imd' boolean (default off, on for some systems (SGI)) global When set the Input Method is never used. This is useful to disable the IM when it doesn't work properly. @@ -3240,7 +3235,7 @@ A jump table for the options with a short description can be found at |Q_op|. may change in later releases. *'iminsert'* *'imi'* -'iminsert' 'imi' number (default 0) +'iminsert' 'imi' number (default 0) local to buffer Specifies whether :lmap or an Input Method (IM) is to be used in Insert mode. Valid values: @@ -3258,7 +3253,7 @@ A jump table for the options with a short description can be found at |Q_op|. It is also used for the argument of commands like "r" and "f". *'imsearch'* *'ims'* -'imsearch' 'ims' number (default -1) +'imsearch' 'ims' number (default -1) local to buffer Specifies whether :lmap or an Input Method (IM) is to be used when entering a search pattern. Valid values: @@ -3275,7 +3270,6 @@ A jump table for the options with a short description can be found at |Q_op|. *'inccommand'* *'icm'* 'inccommand' 'icm' string (default "nosplit") global - When nonempty, shows the effects of |:substitute|, |:smagic|, |:snomagic| and user commands with the |:command-preview| flag as you type. @@ -3334,7 +3328,7 @@ A jump table for the options with a short description can be found at |Q_op|. It is not allowed to change text or jump to another window while evaluating 'includeexpr' |textlock|. - *'incsearch'* *'is'* *'noincsearch'* *'nois'* + *'incsearch'* *'is'* *'noincsearch'* *'nois'* 'incsearch' 'is' boolean (default on) global While typing a search command, show where the pattern, as it was typed @@ -3410,7 +3404,6 @@ A jump table for the options with a short description can be found at |Q_op|. It is not allowed to change text or jump to another window while evaluating 'indentexpr' |textlock|. - *'indentkeys'* *'indk'* 'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e") local to buffer @@ -3433,8 +3426,9 @@ A jump table for the options with a short description can be found at |Q_op|. *'isfname'* *'isf'* 'isfname' 'isf' string (default for Windows: - "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" - otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") + "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" + otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") + ) global The characters specified by this option are included in file names and path names. Filenames are used for commands like "gf", "[i" and in @@ -3484,8 +3478,9 @@ A jump table for the options with a short description can be found at |Q_op|. *'isident'* *'isi'* 'isident' 'isi' string (default for Windows: - "@,48-57,_,128-167,224-235" - otherwise: "@,48-57,_,192-255") + "@,48-57,_,128-167,224-235" + otherwise: "@,48-57,_,192-255") + ) global The characters given by this option are included in identifiers. Identifiers are used in recognizing environment variables and after a @@ -3498,7 +3493,7 @@ A jump table for the options with a short description can be found at |Q_op|. change 'iskeyword' instead. *'iskeyword'* *'isk'* -'iskeyword' 'isk' string (default: @,48-57,_,192-255) +'iskeyword' 'isk' string (default "@,48-57,_,192-255") local to buffer Keywords are used in searching and recognizing with many commands: "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See @@ -3514,7 +3509,7 @@ A jump table for the options with a short description can be found at |Q_op|. uses |:syn-iskeyword|. *'isprint'* *'isp'* -'isprint' 'isp' string (default: "@,161-255") +'isprint' 'isp' string (default "@,161-255") global The characters given by this option are displayed directly on the screen. It is also used for "\p" in a |pattern|. The characters from @@ -3543,6 +3538,12 @@ A jump table for the options with a short description can be found at |Q_op|. Unprintable and zero-width Unicode characters are displayed as . There is no option to specify these characters. + *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* +'joinspaces' 'js' boolean (default off) + global + Insert two spaces after a '.', '?' and '!' with a join command. + Otherwise only one space is inserted. + *'jumpoptions'* *'jop'* 'jumpoptions' 'jop' string (default "") global @@ -3558,13 +3559,7 @@ A jump table for the options with a short description can be found at |Q_op|. |alternate-file| or using |mark-motions| try to restore the |mark-view| in which the action occurred. - *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* -'joinspaces' 'js' boolean (default off) - global - Insert two spaces after a '.', '?' and '!' with a join command. - Otherwise only one space is inserted. - - *'keymap'* *'kmp'* *E544* + *'keymap'* *'kmp'* 'keymap' 'kmp' string (default "") local to buffer Name of a keyboard mapping. See |mbyte-keymap|. @@ -3573,7 +3568,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'imsearch' is also set to one, unless it was -1 Only normal file name characters can be used, `/\*?[|<>` are illegal. - *'keymodel'* *'km'* + *'keymodel'* *'km'* 'keymodel' 'km' string (default "") global List of comma-separated words, which enable special things that keys @@ -3585,7 +3580,7 @@ A jump table for the options with a short description can be found at |Q_op|. Special keys in this context are the cursor keys, , , and . - *'keywordprg'* *'kp'* + *'keywordprg'* *'kp'* 'keywordprg' 'kp' string (default ":Man", Windows: ":help") global or local to buffer |global-local| Program to use for the |K| command. Environment variables are @@ -3646,7 +3641,7 @@ A jump table for the options with a short description can be found at |Q_op|. allowing to switch between mappings for different languages/encodings. Use a mapping to avoid having to type it each time! - *'langmenu'* *'lm'* + *'langmenu'* *'lm'* 'langmenu' 'lm' string (default "") global Language to use for menu translation. Tells which file is loaded @@ -3669,13 +3664,13 @@ A jump table for the options with a short description can be found at |Q_op|. < Warning: This deletes all menus that you defined yourself! *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* -'langremap' 'lrm' boolean (default off) +'langremap' 'lrm' boolean (default off) global When off, setting 'langmap' does not apply to characters resulting from a mapping. If setting 'langmap' disables some of your mappings, make sure this option is off. - *'laststatus'* *'ls'* + *'laststatus'* *'ls'* 'laststatus' 'ls' number (default 2) global The value of this option influences when the last window will have a @@ -3711,7 +3706,7 @@ A jump table for the options with a short description can be found at |Q_op|. Note that characters after an are mostly not displayed with the right amount of white space. - *'lines'* *E593* + *'lines'* *E593* 'lines' number (default 24 or terminal height) global Number of lines of the Vim window. @@ -3777,14 +3772,14 @@ A jump table for the options with a short description can be found at |Q_op|. The cursor is displayed at the start of the space a Tab character occupies, not at the end as usual in Normal mode. To get this cursor position while displaying Tabs with spaces, use: > - :set list lcs=tab:\ \ + :set list lcs=tab:\ \ < Note that list mode will also affect formatting (set with 'textwidth' or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for changing the way tabs are displayed. *'listchars'* *'lcs'* -'listchars' 'lcs' string (default: "tab:> ,trail:-,nbsp:+") +'listchars' 'lcs' string (default "tab:> ,trail:-,nbsp:+") global or local to window |global-local| Strings to use in 'list' mode and for the |:list| command. It is a comma-separated list of string settings. @@ -3883,7 +3878,7 @@ A jump table for the options with a short description can be found at |Q_op|. "precedes". |hl-Whitespace| for "nbsp", "space", "tab", "multispace", "lead" and "trail". - *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* + *'loadplugins'* *'lpl'* *'noloadplugins'* *'nolpl'* 'loadplugins' 'lpl' boolean (default on) global When on the plugin scripts are loaded when starting up |load-plugins|. @@ -3904,7 +3899,7 @@ A jump table for the options with a short description can be found at |Q_op|. when you want to |/\M|. *'makeef'* *'mef'* -'makeef' 'mef' string (default: "") +'makeef' 'mef' string (default "") global Name of the errorfile for the |:make| command (see |:make_makeprg|) and the |:grep| command. @@ -3918,7 +3913,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'makeencoding'* *'menc'* + *'makeencoding'* *'menc'* 'makeencoding' 'menc' string (default "") global or local to buffer |global-local| Encoding used for reading the output of external commands. When empty, @@ -3932,6 +3927,7 @@ A jump table for the options with a short description can be found at |Q_op|. setting to the system locale encoding. Example: > :set makeencoding=char " system locale is used < + *'makeprg'* *'mp'* 'makeprg' 'mp' string (default "make") global or local to buffer |global-local| @@ -3988,7 +3984,7 @@ A jump table for the options with a short description can be found at |Q_op|. command recursion, see |E169|. See also |:function|. - *'maxmapdepth'* *'mmd'* *E223* + *'maxmapdepth'* *'mmd'* *E223* 'maxmapdepth' 'mmd' number (default 1000) global Maximum number of times a mapping is done without resulting in a @@ -4058,15 +4054,15 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|. - *'modeline'* *'ml'* *'nomodeline'* *'noml'* -'modeline' 'ml' boolean (default: on (off for root)) + *'modeline'* *'ml'* *'nomodeline'* *'noml'* +'modeline' 'ml' boolean (default on (off for root)) local to buffer If 'modeline' is on 'modelines' gives the number of lines that is checked for set commands. If 'modeline' is off or 'modelines' is zero no lines are checked. See |modeline|. - *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'* -'modelineexpr' 'mle' boolean (default: off) + *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'* +'modelineexpr' 'mle' boolean (default off) global When on allow some options that are an expression to be set in the modeline. Check the option for whether it is affected by @@ -4081,8 +4077,8 @@ A jump table for the options with a short description can be found at |Q_op|. checked for set commands. If 'modeline' is off or 'modelines' is zero no lines are checked. See |modeline|. - *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* - *E21* + + *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* *E21* 'modifiable' 'ma' boolean (default on) local to buffer When off the buffer contents cannot be changed. The 'fileformat' and @@ -4115,16 +4111,15 @@ A jump table for the options with a short description can be found at |Q_op|. when using "rA" on an "A". *'more'* *'nomore'* -'more' boolean (default: on) +'more' boolean (default on) global When on, listings pause when the whole screen is filled. You will get the |more-prompt|. When this option is off there are no pauses, the listing continues until finished. - *'mouse'* + *'mouse'* 'mouse' string (default "nvi") global - Enables mouse support. For example, to enable the mouse in Normal mode and Visual mode: > :set mouse=nv @@ -4162,7 +4157,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'mousehide' hide mouse pointer while typing text 'selectmode' whether to start Select mode or Visual mode - *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* + *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* 'mousefocus' 'mousef' boolean (default off) global The window that the mouse pointer is on is automatically activated. @@ -4171,7 +4166,7 @@ A jump table for the options with a short description can be found at |Q_op|. default because it makes using the pull down menus a little goofy, as a pointer transit may activate a window unintentionally. - *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* + *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* 'mousehide' 'mh' boolean (default on) global only in the GUI @@ -4229,8 +4224,8 @@ A jump table for the options with a short description can be found at |Q_op|. "g" is " (jump to tag under mouse click) "g" is " ("CTRL-T") - *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'* -'mousemoveevent' 'mousemev' boolean (default off) + *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'* +'mousemoveevent' 'mousemev' boolean (default off) global When on, mouse move events are delivered to the input queue and are available for mapping. The default, off, avoids the mouse movement @@ -4260,7 +4255,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'mouseshape'* *'mouses'* *E547* 'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross, - m:no,ml:up-arrow,v:rightup-arrow") + m:no,ml:up-arrow,v:rightup-arrow") global This option tells Vim what the mouse pointer should look like in different modes. The option is a comma-separated list of parts, much @@ -4327,7 +4322,7 @@ A jump table for the options with a short description can be found at |Q_op|. Defines the maximum time in msec between two mouse clicks for the second click to be recognized as a multi click. - *'nrformats'* *'nf'* + *'nrformats'* *'nf'* 'nrformats' 'nf' string (default "bin,hex") local to buffer This defines what bases Vim will consider for numbers when using the @@ -4375,14 +4370,15 @@ A jump table for the options with a short description can be found at |Q_op|. 'nonu' 'nu' 'nonu' 'nu' 'nornu' 'nornu' 'rnu' 'rnu' -> + > |apple | 1 apple | 2 apple | 2 apple |pear | 2 pear | 1 pear | 1 pear |nobody | 3 nobody | 0 nobody |3 nobody |there | 4 there | 1 there | 1 there < + *'numberwidth'* *'nuw'* -'numberwidth' 'nuw' number (default: 4) +'numberwidth' 'nuw' number (default 4) local to window Minimal number of columns to use for the line number. Only relevant when the 'number' or 'relativenumber' option is set or printing lines @@ -4396,7 +4392,7 @@ A jump table for the options with a short description can be found at |Q_op|. The minimum value is 1, the maximum value is 20. *'omnifunc'* *'ofu'* -'omnifunc' 'ofu' string (default: empty) +'omnifunc' 'ofu' string (default "") local to buffer This option specifies a function to be used for Insert mode omni completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| @@ -4409,8 +4405,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - - *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* + *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* 'opendevice' 'odev' boolean (default off) global only for Windows @@ -4420,9 +4415,8 @@ A jump table for the options with a short description can be found at |Q_op|. Note that on Windows editing "aux.h", "lpt1.txt" and the like also result in editing a device. - - *'operatorfunc'* *'opfunc'* -'operatorfunc' 'opfunc' string (default: empty) + *'operatorfunc'* *'opfunc'* +'operatorfunc' 'opfunc' string (default "") global This option specifies a function to be called by the |g@| operator. See |:map-operator| for more info and an example. The value can be @@ -4432,19 +4426,19 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'packpath'* *'pp'* -'packpath' 'pp' string (default: see 'runtimepath') + *'packpath'* *'pp'* +'packpath' 'pp' string (default see 'runtimepath') + global Directories used to find packages. See |packages| and |packages-runtimepath|. - *'paragraphs'* *'para'* 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") global Specifies the nroff macros that separate paragraphs. These are pairs of two letters (see |object-motions|). - *'pex'* *'patchexpr'* + *'patchexpr'* *'pex'* 'patchexpr' 'pex' string (default "") global Expression which is evaluated to apply a patch to a file and generate @@ -4471,7 +4465,7 @@ A jump table for the options with a short description can be found at |Q_op|. Only normal file name characters can be used, `/\*?[|<>` are illegal. *'path'* *'pa'* *E343* *E345* *E347* *E854* -'path' 'pa' string (default: ".,,") +'path' 'pa' string (default ".,,") global or local to buffer |global-local| This is a list of directories which will be searched when using the |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, @@ -4517,7 +4511,7 @@ A jump table for the options with a short description can be found at |Q_op|. < Replace the ';' with a ':' or whatever separator is used. Note that this doesn't work when $INCL contains a comma or white space. - *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* + *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* 'preserveindent' 'pi' boolean (default off) local to buffer When changing the indent of the current line, preserve as much of the @@ -4533,15 +4527,14 @@ A jump table for the options with a short description can be found at |Q_op|. Also see 'copyindent'. Use |:retab| to clean up white space. - *'previewheight'* *'pvh'* -'previewheight' 'pvh' number (default 12) + *'previewheight'* *'pvh'* +'previewheight' 'pvh' number (default 12) global Default height for a preview window. Used for |:ptag| and associated commands. Used for |CTRL-W_}| when no count is given. - *'previewwindow'* *'nopreviewwindow'* - *'pvw'* *'nopvw'* *E590* -'previewwindow' 'pvw' boolean (default off) + *'previewwindow'* *'pvw'* *'nopreviewwindow'* *'nopvw'* *E590* +'previewwindow' 'pvw' boolean (default off) local to window Identifies the preview window. Only one window can have this option set. It's normally not set directly, but by using one of the commands @@ -4586,8 +4579,8 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'quickfixtextfunc'* *'qftf'* -'quickfixtextfunc' 'qftf' string (default "") + *'quickfixtextfunc'* *'qftf'* +'quickfixtextfunc' 'qftf' string (default "") global This option specifies a function to be used to get the text to display in the quickfix and location list windows. This can be used to @@ -4610,7 +4603,7 @@ A jump table for the options with a short description can be found at |Q_op|. the following character will be skipped. The default value makes the text "foo\"bar\\" considered to be one string. - *'readonly'* *'ro'* *'noreadonly'* *'noro'* + *'readonly'* *'ro'* *'noreadonly'* *'noro'* 'readonly' 'ro' boolean (default off) local to buffer If on, writes fail unless you use a '!'. Protects you from @@ -4623,7 +4616,7 @@ A jump table for the options with a short description can be found at |Q_op|. See 'modifiable' for disallowing changes to the buffer. *'redrawdebug'* *'rdb'* -'redrawdebug' 'rdb' string (default '') +'redrawdebug' 'rdb' string (default "") global Flags to change the way redrawing works, for debugging purposes. Most useful with 'writedelay' set to some reasonable value. @@ -4706,7 +4699,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'number', see |number_relativenumber| for all combinations of the two options. - *'report'* + *'report'* 'report' number (default 2) global Threshold for reporting number of lines changed. When the number of @@ -4722,7 +4715,7 @@ A jump table for the options with a short description can be found at |Q_op|. backwards" |ins-reverse|. This option can be toggled with the CTRL-_ command in Insert mode, when 'allowrevins' is set. - *'rightleft'* *'rl'* *'norightleft'* *'norl'* + *'rightleft'* *'rl'* *'norightleft'* *'norl'* 'rightleft' 'rl' boolean (default off) local to window When on, display orientation becomes right-to-left, i.e., characters @@ -4735,7 +4728,7 @@ A jump table for the options with a short description can be found at |Q_op|. and left-to-right strings so that both sets are displayed properly in different windows). Also see |rileft.txt|. - *'rightleftcmd'* *'rlc'* + *'rightleftcmd'* *'rlc'* 'rightleftcmd' 'rlc' string (default "search") local to window Each word in this option enables the command line editing to work in @@ -4746,7 +4739,7 @@ A jump table for the options with a short description can be found at |Q_op|. This is useful for languages such as Hebrew, Arabic and Farsi. The 'rightleft' option must be set for 'rightleftcmd' to take effect. - *'ruler'* *'ru'* *'noruler'* *'noru'* + *'ruler'* *'ru'* *'noruler'* *'noru'* 'ruler' 'ru' boolean (default on) global Show the line and column number of the cursor position, separated by a @@ -4773,7 +4766,7 @@ A jump table for the options with a short description can be found at |Q_op|. you are, use "g CTRL-G" |g_CTRL-G|. *'rulerformat'* *'ruf'* -'rulerformat' 'ruf' string (default empty) +'rulerformat' 'ruf' string (default "") global When this option is not empty, it determines the content of the ruler string, as displayed for the 'ruler' option. @@ -4785,24 +4778,25 @@ A jump table for the options with a short description can be found at |Q_op|. Example: > :set rulerformat=%15(%c%V\ %p%%%) < - *'runtimepath'* *'rtp'* *vimfiles* -'runtimepath' 'rtp' string (default: "$XDG_CONFIG_HOME/nvim, - $XDG_CONFIG_DIRS[1]/nvim, - $XDG_CONFIG_DIRS[2]/nvim, - … - $XDG_DATA_HOME/nvim[-data]/site, - $XDG_DATA_DIRS[1]/nvim/site, - $XDG_DATA_DIRS[2]/nvim/site, - … - $VIMRUNTIME, - … - $XDG_DATA_DIRS[2]/nvim/site/after, - $XDG_DATA_DIRS[1]/nvim/site/after, - $XDG_DATA_HOME/nvim[-data]/site/after, - … - $XDG_CONFIG_DIRS[2]/nvim/after, - $XDG_CONFIG_DIRS[1]/nvim/after, - $XDG_CONFIG_HOME/nvim/after") + + *'runtimepath'* *'rtp'* *vimfiles* +'runtimepath' 'rtp' string (default "$XDG_CONFIG_HOME/nvim, + $XDG_CONFIG_DIRS[1]/nvim, + $XDG_CONFIG_DIRS[2]/nvim, + … + $XDG_DATA_HOME/nvim[-data]/site, + $XDG_DATA_DIRS[1]/nvim/site, + $XDG_DATA_DIRS[2]/nvim/site, + … + $VIMRUNTIME, + … + $XDG_DATA_DIRS[2]/nvim/site/after, + $XDG_DATA_DIRS[1]/nvim/site/after, + $XDG_DATA_HOME/nvim[-data]/site/after, + … + $XDG_CONFIG_DIRS[2]/nvim/after, + $XDG_CONFIG_DIRS[1]/nvim/after, + $XDG_CONFIG_HOME/nvim/after") global List of directories to be searched for these runtime files: filetype.lua filetypes |new-filetype| @@ -4872,7 +4866,7 @@ A jump table for the options with a short description can be found at |Q_op|. With |--clean| the home directory entries are not included. *'scroll'* *'scr'* -'scroll' 'scr' number (default: half the window height) +'scroll' 'scr' number (default half the window height) local to window Number of lines to scroll with CTRL-U and CTRL-D commands. Will be set to half the number of lines in the window when the window size @@ -4883,7 +4877,7 @@ A jump table for the options with a short description can be found at |Q_op|. height with ":set scroll=0". *'scrollback'* *'scbk'* -'scrollback' 'scbk' number (default: 10000) +'scrollback' 'scbk' number (default 10000) local to buffer Maximum number of lines kept beyond the visible screen. Lines at the top are deleted if new lines exceed this limit. @@ -4894,7 +4888,7 @@ A jump table for the options with a short description can be found at |Q_op|. reflown when the terminal buffer is resized horizontally. *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* -'scrollbind' 'scb' boolean (default off) +'scrollbind' 'scb' boolean (default off) local to window See also |scroll-binding|. When this option is set, the current window scrolls as other scrollbind windows (windows that also have @@ -5000,9 +4994,8 @@ A jump table for the options with a short description can be found at |Q_op|. cmd when using "v", "V" or CTRL-V See |Select-mode|. - *'sessionoptions'* *'ssop'* -'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, - help,tabpages,winsize,terminal") + *'sessionoptions'* *'ssop'* +'sessionoptions' 'ssop' string (default "blank,buffers,curdir,folds,help,tabpages,winsize,terminal") global Changes the effect of the |:mksession| command. It is a comma- separated list of words. Each word enables saving and restoring @@ -5041,10 +5034,11 @@ A jump table for the options with a short description can be found at |Q_op|. filenames are stored as absolute paths. If you leave out "options" many things won't work well after restoring the session. - *'shada'* *'sd'* *E526* *E527* *E528* + + *'shada'* *'sd'* *E526* *E527* *E528* 'shada' 'sd' string (default for - Win32: !,'100,<50,s10,h,rA:,rB: - others: !,'100,<50,s10,h) + Win32: !,'100,<50,s10,h,rA:,rB: + others: !,'100,<50,s10,h) global When non-empty, the shada file is read upon startup and written when exiting Vim (see |shada-file|). The string should be a comma- @@ -5157,8 +5151,8 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'shadafile'* *'sdf'* -'shadafile' 'sdf' string (default: "") + *'shadafile'* *'sdf'* +'shadafile' 'sdf' string (default "") global When non-empty, overrides the file name used for |shada| (viminfo). When equal to "NONE" no shada file will be read or written. @@ -5217,7 +5211,7 @@ A jump table for the options with a short description can be found at |Q_op|. security reasons. *'shellcmdflag'* *'shcf'* -'shellcmdflag' 'shcf' string (default: "-c"; Windows: "/s /c") +'shellcmdflag' 'shcf' string (default "-c"; Windows: "/s /c") global Flag passed to the shell to execute "!" and ":!" commands; e.g., `bash.exe -c ls` or `cmd.exe /s /c "dir"`. For MS-Windows, the @@ -5264,8 +5258,8 @@ A jump table for the options with a short description can be found at |Q_op|. security reasons. *'shellquote'* *'shq'* -'shellquote' 'shq' string (default: ""; Windows, when 'shell' - contains "sh" somewhere: "\"") +'shellquote' 'shq' string (default ""; Windows, when 'shell' + contains "sh" somewhere: "\"") global Quoting character(s), put around the command passed to the shell, for the "!" and ":!" commands. The redirection is kept outside of the @@ -5335,14 +5329,14 @@ A jump table for the options with a short description can be found at |Q_op|. |system()| does not respect this option, it always uses pipes. *'shellxescape'* *'sxe'* -'shellxescape' 'sxe' string (default: "") +'shellxescape' 'sxe' string (default "") global When 'shellxquote' is set to "(" then the characters listed in this option will be escaped with a '^' character. This makes it possible to execute most external commands with cmd.exe. *'shellxquote'* *'sxq'* -'shellxquote' 'sxq' string (default: "", Windows: "\"") +'shellxquote' 'sxq' string (default "", Windows: "\"") global Quoting character(s), put around the command passed to the shell, for the "!" and ":!" commands. Includes the redirection. See @@ -5369,9 +5363,9 @@ A jump table for the options with a short description can be found at |Q_op|. When zero the 'tabstop' value will be used. Use the |shiftwidth()| function to get the effective shiftwidth value. - *'shortmess'* *'shm'* + *'shortmess'* *'shm'* *E1336* 'shortmess' 'shm' string (default "filnxtToOCF") - global *E1336* + global This option helps to avoid all the |hit-enter| prompts caused by file messages, for example with CTRL-G, and to avoid some other messages. It is a list of flags: @@ -5429,14 +5423,12 @@ A jump table for the options with a short description can be found at |Q_op|. shm=a Abbreviation, but no loss of information. shm=at Abbreviation, and truncate message when necessary. - *'showbreak'* *'sbr'* *E595* + *'showbreak'* *'sbr'* *E595* 'showbreak' 'sbr' string (default "") global or local to window |global-local| String to put at the start of lines that have been wrapped. Useful values are "> " or "+++ ": > - :set showbreak=>\ -< Note the backslash to escape the trailing space. It's easier like - this: > + :let &showbreak = "> " :let &showbreak = '+++ ' < Only printable single-cell characters are allowed, excluding and comma (in a future version the comma might be used to separate the @@ -5449,8 +5441,9 @@ A jump table for the options with a short description can be found at |Q_op|. set and you want no value in the current window use NONE: > :setlocal showbreak=NONE < - *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* -'showcmd' 'sc' boolean (default: on) + + *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* +'showcmd' 'sc' boolean (default on) global Show (partial) command in the last line of the screen. Set this option off if your terminal is slow. @@ -5464,7 +5457,7 @@ A jump table for the options with a short description can be found at |Q_op|. This information can be displayed in an alternative location using the 'showcmdloc' option, useful when 'cmdheight' is 0. - *'showcmdloc'* *'sloc'* + *'showcmdloc'* *'sloc'* 'showcmdloc' 'sloc' string (default "last") global This option can be used to display the (partially) entered command in @@ -5480,7 +5473,7 @@ A jump table for the options with a short description can be found at |Q_op|. displayed in a convenient location. *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* -'showfulltag' 'sft' boolean (default off) +'showfulltag' 'sft' boolean (default off) global When completing a word in insert mode (see |ins-completion|) from the tags file, show both the tag name and a tidied-up form of the search @@ -5491,7 +5484,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'completeopt', because the completion from the search pattern may not match the typed text. - *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* + *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* 'showmatch' 'sm' boolean (default off) global When a bracket is inserted, briefly jump to the matching one. The @@ -5510,8 +5503,8 @@ A jump table for the options with a short description can be found at |Q_op|. around |pi_paren.txt|. Note: Use of the short form is rated PG. - *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* -'showmode' 'smd' boolean (default: on) + *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* +'showmode' 'smd' boolean (default on) global If in Insert, Replace or Visual mode put a message on the last line. The |hl-ModeMsg| highlight group determines the highlighting. @@ -5538,8 +5531,8 @@ A jump table for the options with a short description can be found at |Q_op|. When using a slow terminal set it to a large number or 0. Not used for "zh" and "zl" commands. - *'sidescrolloff'* *'siso'* -'sidescrolloff' 'siso' number (default 0) + *'sidescrolloff'* *'siso'* +'sidescrolloff' 'siso' number (default 0) global or local to window |global-local| The minimal number of screen columns to keep to the left and to the right of the cursor if 'nowrap' is set. Setting this option to a @@ -5561,6 +5554,7 @@ A jump table for the options with a short description can be found at |Q_op|. :set nowrap sidescroll=1 listchars=extends:>,precedes:< :set sidescrolloff=1 < + *'signcolumn'* *'scl'* 'signcolumn' 'scl' string (default "auto") local to window @@ -5587,7 +5581,6 @@ A jump table for the options with a short description can be found at |Q_op|. This is done in order for the signcolumn appearance not appear weird during line deletion. - *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* 'smartcase' 'scs' boolean (default off) global @@ -5598,7 +5591,7 @@ A jump table for the options with a short description can be found at |Q_op|. "*" and "#" you can make 'smartcase' used by doing a "/" command, recalling the search pattern from history and hitting . - *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* + *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* 'smartindent' 'si' boolean (default off) local to buffer Do smart autoindenting when starting a new line. Works for C-like @@ -5621,7 +5614,7 @@ A jump table for the options with a short description can be found at |Q_op|. When using the ">>" command, lines starting with '#' are not shifted right. - *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* + *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* 'smarttab' 'sta' boolean (default on) global When on, a in front of a line inserts blanks according to @@ -5636,7 +5629,7 @@ A jump table for the options with a short description can be found at |Q_op|. number of spaces is minimized by using s. *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'* -'smoothscroll' 'sms' boolean (default off) +'smoothscroll' 'sms' boolean (default off) local to window Scrolling works with screen lines. When 'wrap' is set and the first line in the window wraps part of it may not be visible, as if it is @@ -5647,7 +5640,7 @@ A jump table for the options with a short description can be found at |Q_op|. NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y and scrolling with the mouse. - *'softtabstop'* *'sts'* + *'softtabstop'* *'sts'* 'softtabstop' 'sts' number (default 0) local to buffer Number of spaces that a counts for while performing editing @@ -5673,7 +5666,7 @@ A jump table for the options with a short description can be found at |Q_op|. The languages are specified with 'spelllang'. *'spellcapcheck'* *'spc'* -'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") +'spellcapcheck' 'spc' string (default "[.?!]\_[\])'"\t ]\+") local to buffer Pattern to locate the end of a sentence. The following word will be checked to start with a capital letter. If not then it is highlighted @@ -5686,7 +5679,7 @@ A jump table for the options with a short description can be found at |Q_op|. |set-spc-auto|. *'spellfile'* *'spf'* -'spellfile' 'spf' string (default empty) +'spellfile' 'spf' string (default "") local to buffer Name of the word list file where words are added for the |zg| and |zw| commands. It must end in ".{encoding}.add". You need to include the @@ -5830,14 +5823,13 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* 'splitbelow' 'sb' boolean (default off) global When on, splitting a window will put the new window below the current one. |:split| - *'splitkeep'* *'spk'* + *'splitkeep'* *'spk'* 'splitkeep' 'spk' string (default "cursor") global The value of this option determines the scroll behavior when opening, @@ -5859,7 +5851,7 @@ A jump table for the options with a short description can be found at |Q_op|. When on, splitting a window will put the new window right of the current one. |:vsplit| - *'startofline'* *'sol'* *'nostartofline'* *'nosol'* + *'startofline'* *'sol'* *'nostartofline'* *'nosol'* 'startofline' 'sol' boolean (default off) global When "on" the commands listed below move the cursor to the first @@ -5873,8 +5865,8 @@ A jump table for the options with a short description can be found at |Q_op|. In case of buffer changing commands the cursor is placed at the column where it was the last time the buffer was edited. - *'statuscolumn'* *'stc'* -'statuscolumn' 'stc' string (default: empty) + *'statuscolumn'* *'stc'* +'statuscolumn' 'stc' string (default "") local to window EXPERIMENTAL When non-empty, this option determines the content of the area to the @@ -5927,8 +5919,8 @@ A jump table for the options with a short description can be found at |Q_op|. < WARNING: this expression is evaluated for each screen line so defining an expensive expression can negatively affect render performance. - *'statusline'* *'stl'* *E540* *E542* -'statusline' 'stl' string (default empty) + *'statusline'* *'stl'* *E540* *E542* +'statusline' 'stl' string (default "") global or local to window |global-local| When non-empty, this option determines the content of the status line. Also see |status-line|. @@ -6139,6 +6131,7 @@ A jump table for the options with a short description can be found at |Q_op|. : if exists(a:var) | return a:val | else | return '' | endif :endfunction < + *'suffixes'* *'su'* 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") global @@ -6160,8 +6153,9 @@ A jump table for the options with a short description can be found at |Q_op|. file for the "gf", "[I", etc. commands. Example: > :set suffixesadd=.java < + *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* -'swapfile' 'swf' boolean (default on) +'swapfile' 'swf' boolean (default on) local to buffer Use a swapfile for the buffer. This option can be reset when a swapfile is not wanted for a specific buffer. For example, with @@ -6222,7 +6216,7 @@ A jump table for the options with a short description can be found at |Q_op|. Set to zero to remove the limit. *'syntax'* *'syn'* -'syntax' 'syn' string (default empty) +'syntax' 'syn' string (default "") local to buffer When this option is set, the syntax with this name is loaded, unless syntax highlighting has been switched off with ":syntax off". @@ -6249,7 +6243,7 @@ A jump table for the options with a short description can be found at |Q_op|. Only normal file name characters can be used, `/\*?[|<>` are illegal. *'tabline'* *'tal'* -'tabline' 'tal' string (default empty) +'tabline' 'tal' string (default "") global When non-empty, this option determines the content of the tab pages line at the top of the Vim window. When empty Vim will use a default @@ -6272,14 +6266,12 @@ A jump table for the options with a short description can be found at |Q_op|. Keep in mind that only one of the tab pages is the current one, others are invisible and you can't jump to their windows. - *'tabpagemax'* *'tpm'* 'tabpagemax' 'tpm' number (default 50) global Maximum number of tab pages to be opened by the |-p| command line argument or the ":tab all" command. |tabpage| - *'tabstop'* *'ts'* 'tabstop' 'ts' number (default 8) local to buffer @@ -6341,7 +6333,7 @@ A jump table for the options with a short description can be found at |Q_op|. Linear searching is done anyway, for one file, when Vim finds a line at the start of the file indicating that it's not sorted: > - !_TAG_FILE_SORTED 0 /some comment/ + !_TAG_FILE_SORTED 0 /some comment/ < [The whitespace before and after the '0' must be a single ] When a binary search was done and no match was found in any of the @@ -6375,7 +6367,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option doesn't affect commands that find all matching tags (e.g., command-line completion and ":help"). - *'tagcase'* *'tc'* + *'tagcase'* *'tc'* 'tagcase' 'tc' string (default "followic") global or local to buffer |global-local| This option specifies how case is handled when searching the tags @@ -6386,8 +6378,8 @@ A jump table for the options with a short description can be found at |Q_op|. match Match case smart Ignore case unless an upper case letter is used - *'tagfunc'* *'tfu'* -'tagfunc' 'tfu' string (default: empty) + *'tagfunc'* *'tfu'* +'tagfunc' 'tfu' string (default "") local to buffer This option specifies a function to be used to perform tag searches. The function gets the tag pattern and should return a List of matching @@ -6402,7 +6394,7 @@ A jump table for the options with a short description can be found at |Q_op|. If non-zero, tags are significant up to this number of characters. *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* -'tagrelative' 'tr' boolean (default: on) +'tagrelative' 'tr' boolean (default on) global If on and using a tags file in another directory, file names in that tags file are relative to the directory where the tags file is. @@ -6428,7 +6420,7 @@ A jump table for the options with a short description can be found at |Q_op|. file names from the list. This avoids problems when a future version uses another default. - *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* + *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* 'tagstack' 'tgst' boolean (default on) global When on, the |tagstack| is used normally. When off, a ":tag" or @@ -6439,9 +6431,8 @@ A jump table for the options with a short description can be found at |Q_op|. Resetting this option is useful when using a ":tag" command in a mapping which should not change the tagstack. - *'termbidi'* *'tbidi'* - *'notermbidi'* *'notbidi'* -'termbidi' 'tbidi' boolean (default off) + *'termbidi'* *'tbidi'* *'notermbidi'* *'notbidi'* +'termbidi' 'tbidi' boolean (default off) global The terminal is in charge of Bi-directionality of text (as specified by Unicode). The terminal is also expected to do the required shaping @@ -6452,15 +6443,15 @@ A jump table for the options with a short description can be found at |Q_op|. 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. For further details see |arabic.txt|. - *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* -'termguicolors' 'tgc' boolean (default off) + *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* +'termguicolors' 'tgc' boolean (default off) global Enables 24-bit RGB color in the |TUI|. Uses "gui" |:highlight| attributes instead of "cterm" attributes. |guifg| Requires an ISO-8613-3 compatible terminal. - *'termpastefilter'* *'tpf'* -'termpastefilter' 'tpf' string (default: "BS,HT,ESC,DEL") + *'termpastefilter'* *'tpf'* +'termpastefilter' 'tpf' string (default "BS,HT,ESC,DEL") global A comma-separated list of options for specifying control characters to be removed from the text pasted into the terminal window. The @@ -6481,7 +6472,6 @@ A jump table for the options with a short description can be found at |Q_op|. C1 Control characters 0x80...0x9F - *'textwidth'* *'tw'* 'textwidth' 'tw' number (default 0) local to buffer @@ -6510,8 +6500,8 @@ A jump table for the options with a short description can be found at |Q_op|. another default. Backticks cannot be used in this option for security reasons. - *'thesaurusfunc'* *'tsrfu'* -'thesaurusfunc' 'tsrfu' string (default: empty) + *'thesaurusfunc'* *'tsrfu'* +'thesaurusfunc' 'tsrfu' string (default "") global or local to buffer |global-local| This option specifies a function to be used for thesaurus completion with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|. @@ -6521,46 +6511,24 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'tildeop'* *'top'* *'notildeop'* *'notop'* + *'tildeop'* *'top'* *'notildeop'* *'notop'* 'tildeop' 'top' boolean (default off) global When on: The tilde command "~" behaves like an operator. *'timeout'* *'to'* *'notimeout'* *'noto'* -'timeout' 'to' boolean (default on) +'timeout' 'to' boolean (default on) global This option and 'timeoutlen' determine the behavior when part of a mapped key sequence has been received. For example, if is pressed and 'timeout' is set, Nvim will wait 'timeoutlen' milliseconds for any key that can follow in a mapping. - *'ttimeout'* *'nottimeout'* -'ttimeout' boolean (default on) - global - This option and 'ttimeoutlen' determine the behavior when part of a - key code sequence has been received by the |TUI|. - - For example if (the \x1b byte) is received and 'ttimeout' is - set, Nvim waits 'ttimeoutlen' milliseconds for the terminal to - complete a key code sequence. If no input arrives before the timeout, - a single is assumed. Many TUI cursor key codes start with . - - On very slow systems this may fail, causing cursor keys not to work - sometimes. If you discover this problem you can ":set ttimeoutlen=9999". - Nvim will wait for the next character to arrive after an . - *'timeoutlen'* *'tm'* 'timeoutlen' 'tm' number (default 1000) global Time in milliseconds to wait for a mapped sequence to complete. - *'ttimeoutlen'* *'ttm'* -'ttimeoutlen' 'ttm' number (default 50) - global - Time in milliseconds to wait for a key code sequence to complete. Also - used for CTRL-\ CTRL-N and CTRL-\ CTRL-G when part of a command has - been typed. - *'title'* *'notitle'* 'title' boolean (default off) global @@ -6576,7 +6544,7 @@ A jump table for the options with a short description can be found at |Q_op|. (path) is the path of the file being edited - NVIM the server name |v:servername| or "NVIM" - *'titlelen'* + *'titlelen'* 'titlelen' number (default 85) global Gives the percentage of 'columns' to use for the length of the window @@ -6589,14 +6557,15 @@ A jump table for the options with a short description can be found at |Q_op|. values from 1 to 30000 percent can be used. 'titlelen' is also used for the 'titlestring' option. - *'titleold'* + *'titleold'* 'titleold' string (default "") global If not empty, this option will be used to set the window title when exiting. Only if 'title' is enabled. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - *'titlestring'* + + *'titlestring'* 'titlestring' string (default "") global When this option is not empty, it will be used for the title of the @@ -6619,7 +6588,29 @@ A jump table for the options with a short description can be found at |Q_op|. NOTE: Use of special characters in 'titlestring' may cause the display to be garbled (e.g., when it contains a CR or NL character). - *'undodir'* *'udir'* *E5003* + *'ttimeout'* *'nottimeout'* +'ttimeout' boolean (default on) + global + This option and 'ttimeoutlen' determine the behavior when part of a + key code sequence has been received by the |TUI|. + + For example if (the \x1b byte) is received and 'ttimeout' is + set, Nvim waits 'ttimeoutlen' milliseconds for the terminal to + complete a key code sequence. If no input arrives before the timeout, + a single is assumed. Many TUI cursor key codes start with . + + On very slow systems this may fail, causing cursor keys not to work + sometimes. If you discover this problem you can ":set ttimeoutlen=9999". + Nvim will wait for the next character to arrive after an . + + *'ttimeoutlen'* *'ttm'* +'ttimeoutlen' 'ttm' number (default 50) + global + Time in milliseconds to wait for a key code sequence to complete. Also + used for CTRL-\ CTRL-N and CTRL-\ CTRL-G when part of a command has + been typed. + + *'undodir'* *'udir'* 'undodir' 'udir' string (default "$XDG_STATE_HOME/nvim/undo//") global List of directory names for undo files, separated with commas. @@ -6643,7 +6634,7 @@ A jump table for the options with a short description can be found at |Q_op|. though the trailing slashes are present (see 'backupdir' for what this means). - *'undofile'* *'noundofile'* *'udf'* *'noudf'* + *'undofile'* *'udf'* *'noundofile'* *'noudf'* 'undofile' 'udf' boolean (default off) local to buffer When on, Vim automatically saves undo history to an undo file when @@ -6692,7 +6683,7 @@ A jump table for the options with a short description can be found at |Q_op|. this option to a lower value if you run out of memory. *'updatecount'* *'uc'* -'updatecount' 'uc' number (default: 200) +'updatecount' 'uc' number (default 200) global After typing this many characters the swap file will be written to disk. When zero, no swap file will be created at all (see chapter on @@ -6775,7 +6766,7 @@ A jump table for the options with a short description can be found at |Q_op|. If 'verbosefile' is set then the verbose messages are not displayed. *'verbosefile'* *'vfile'* -'verbosefile' 'vfile' string (default empty) +'verbosefile' 'vfile' string (default "") global When not empty all messages are written in a file with this name. When the file exists messages are appended. @@ -6786,14 +6777,14 @@ A jump table for the options with a short description can be found at |Q_op|. displayed when 'verbosefile' is set. *'viewdir'* *'vdir'* -'viewdir' 'vdir' string (default: "$XDG_STATE_HOME/nvim/view//") +'viewdir' 'vdir' string (default "$XDG_STATE_HOME/nvim/view//") global Name of the directory where to store files for |:mkview|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. *'viewoptions'* *'vop'* -'viewoptions' 'vop' string (default: "folds,cursor,curdir") +'viewoptions' 'vop' string (default "folds,cursor,curdir") global Changes the effect of the |:mkview| command. It is a comma-separated list of words. Each word enables saving and restoring something: @@ -6808,7 +6799,7 @@ A jump table for the options with a short description can be found at |Q_op|. slash |deprecated| Always enabled. Uses "/" in filenames. unix |deprecated| Always enabled. Uses "\n" line endings. - *'virtualedit'* *'ve'* + *'virtualedit'* *'ve'* 'virtualedit' 've' string (default "") global or local to window |global-local| A comma-separated list of these words: @@ -6838,7 +6829,7 @@ A jump table for the options with a short description can be found at |Q_op|. not get a warning for it. When combined with other words, "none" is ignored. - *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* + *'visualbell'* *'vb'* *'novisualbell'* *'novb'* 'visualbell' 'vb' boolean (default off) global Use visual bell instead of beeping. Also see 'errorbells'. @@ -6850,7 +6841,7 @@ A jump table for the options with a short description can be found at |Q_op|. has been changed. *'whichwrap'* *'ww'* -'whichwrap' 'ww' string (default: "b,s") +'whichwrap' 'ww' string (default "b,s") global Allow specified keys that move the cursor left/right to move to the previous/next line when the cursor is on the first/last character in @@ -6880,7 +6871,7 @@ A jump table for the options with a short description can be found at |Q_op|. makes "dl", "cl", "yl" etc. work normally. *'wildchar'* *'wc'* -'wildchar' 'wc' number (default: ) +'wildchar' 'wc' number (default ) global Character you have to type to start wildcard expansion in the command-line, as specified with 'wildmode'. @@ -6893,7 +6884,7 @@ A jump table for the options with a short description can be found at |Q_op|. < *'wildcharm'* *'wcm'* -'wildcharm' 'wcm' number (default: none (0)) +'wildcharm' 'wcm' number (default 0) global 'wildcharm' works exactly like 'wildchar', except that it is recognized when used inside a macro. You can find "spare" command-line @@ -6919,8 +6910,7 @@ A jump table for the options with a short description can be found at |Q_op|. a pattern from the list. This avoids problems when a future version uses another default. - - *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* + *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* 'wildignorecase' 'wic' boolean (default off) global When set case is ignored when completing file names and directories. @@ -6928,8 +6918,7 @@ A jump table for the options with a short description can be found at |Q_op|. Does not apply when the shell is used to expand wildcards, which happens when there are special characters. - - *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* + *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* 'wildmenu' 'wmnu' boolean (default on) global When 'wildmenu' is on, command-line completion operates in an enhanced @@ -6968,7 +6957,7 @@ A jump table for the options with a short description can be found at |Q_op|. |hl-WildMenu| highlights the current match. *'wildmode'* *'wim'* -'wildmode' 'wim' string (default: "full") +'wildmode' 'wim' string (default "full") global Completion mode that is used for the character specified with 'wildchar'. It is a comma-separated list of up to four parts. Each @@ -7055,7 +7044,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option is not used for ; on Win32. *'winbar'* *'wbr'* -'winbar' 'wbr' string (default empty) +'winbar' 'wbr' string (default "") global or local to window |global-local| When non-empty, this option enables the window bar and determines its contents. The window bar is a bar that's shown at the top of every @@ -7072,7 +7061,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set in a modeline when 'modelineexpr' is off. *'winblend'* *'winbl'* -'winblend' 'winbl' number (default 0) +'winblend' 'winbl' number (default 0) local to window Enables pseudo-transparency for a floating window. Valid values are in the range of 0 for fully opaque window (disabled) to 100 for fully @@ -7080,8 +7069,8 @@ A jump table for the options with a short description can be found at |Q_op|. UI-dependent. Works best with RGB colors. 'termguicolors' - *'window'* *'wi'* -'window' 'wi' number (default screen height - 1) + *'window'* *'wi'* +'window' 'wi' number (default screen height - 1) global Window height used for |CTRL-F| and |CTRL-B| when there is only one window and the value is smaller than 'lines' minus one. The screen @@ -7093,6 +7082,21 @@ A jump table for the options with a short description can be found at |Q_op|. Note: Do not confuse this with the height of the Vim window, use 'lines' for that. + *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* +'winfixheight' 'wfh' boolean (default off) + local to window + Keep the window height when windows are opened or closed and + 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the + |preview-window| and |quickfix-window|. + The height may be changed anyway when running out of room. + + *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* +'winfixwidth' 'wfw' boolean (default off) + local to window + Keep the window width when windows are opened or closed and + 'equalalways' is set. Also for |CTRL-W_=|. + The width may be changed anyway when running out of room. + *'winheight'* *'wh'* *E591* 'winheight' 'wh' number (default 1) global @@ -7113,8 +7117,8 @@ A jump table for the options with a short description can be found at |Q_op|. 'winheight' applies to the current window. Use 'winminheight' to set the minimal height for other windows. - *'winhighlight'* *'winhl'* -'winhighlight' 'winhl' string (default empty) + *'winhighlight'* *'winhl'* +'winhighlight' 'winhl' string (default "") local to window Window-local highlights. Comma-delimited list of highlight |group-name| pairs "{hl-from}:{hl-to},..." where each {hl-from} is @@ -7133,20 +7137,6 @@ A jump table for the options with a short description can be found at |Q_op|. Example: show a different color for non-current windows: > set winhighlight=Normal:MyNormal,NormalNC:MyNormalNC < - *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* -'winfixheight' 'wfh' boolean (default off) - local to window - Keep the window height when windows are opened or closed and - 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the - |preview-window| and |quickfix-window|. - The height may be changed anyway when running out of room. - - *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* -'winfixwidth' 'wfw' boolean (default off) - local to window - Keep the window width when windows are opened or closed and - 'equalalways' is set. Also for |CTRL-W_=|. - The width may be changed anyway when running out of room. *'winminheight'* *'wmh'* 'winminheight' 'wmh' number (default 1) @@ -7218,13 +7208,13 @@ A jump table for the options with a short description can be found at |Q_op|. When 'textwidth' is non-zero, this option is not used. See also 'formatoptions' and |ins-textwidth|. - *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* -'wrapscan' 'ws' boolean (default on) *E384* *E385* + *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* *E384* *E385* +'wrapscan' 'ws' boolean (default on) global Searches wrap around the end of the file. Also applies to |]s| and |[s|, searching for spelling mistakes. - *'write'* *'nowrite'* + *'write'* *'nowrite'* 'write' boolean (default on) global Allows writing files. When not set, writing a file is not allowed. @@ -7233,12 +7223,12 @@ A jump table for the options with a short description can be found at |Q_op|. argument. Filtering text is still possible, even though this requires writing a temporary file. - *'writeany'* *'wa'* *'nowriteany'* *'nowa'* + *'writeany'* *'wa'* *'nowriteany'* *'nowa'* 'writeany' 'wa' boolean (default off) global Allows writing to any file with no need for "!" override. - *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* + *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* 'writebackup' 'wb' boolean (default on) global Make a backup before overwriting a file. The backup is removed after -- cgit From 1f252a8ac0d1ca23777978fcef07bd7fab309494 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Sat, 5 Aug 2023 07:55:45 +0800 Subject: docs(options): fix mistakes (#24568) --- runtime/doc/options.txt | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 70329a170a..fca73ddd1e 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -904,7 +904,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'backupskip'* *'bsk'* 'backupskip' 'bsk' string (default "$TMPDIR/*,$TMP/*,$TEMP/*" Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*" - Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")) + Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") global A list of file patterns. When one of the patterns matches with the name of the file which is written, no backup file is created. Both @@ -3102,7 +3102,6 @@ A jump table for the options with a short description can be found at |Q_op|. *'helpfile'* *'hf'* 'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt" (others) "$VIMRUNTIME/doc/help.txt") - ) global Name of the main help file. All distributed help files should be placed together in one directory. Additionally, all "doc" directories @@ -3428,7 +3427,6 @@ A jump table for the options with a short description can be found at |Q_op|. 'isfname' 'isf' string (default for Windows: "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") - ) global The characters specified by this option are included in file names and path names. Filenames are used for commands like "gf", "[i" and in @@ -3480,7 +3478,6 @@ A jump table for the options with a short description can be found at |Q_op|. 'isident' 'isi' string (default for Windows: "@,48-57,_,128-167,224-235" otherwise: "@,48-57,_,192-255") - ) global The characters given by this option are included in identifiers. Identifiers are used in recognizing environment variables and after a @@ -6610,7 +6607,7 @@ A jump table for the options with a short description can be found at |Q_op|. used for CTRL-\ CTRL-N and CTRL-\ CTRL-G when part of a command has been typed. - *'undodir'* *'udir'* + *'undodir'* *'udir'* *E5003* 'undodir' 'udir' string (default "$XDG_STATE_HOME/nvim/undo//") global List of directory names for undo files, separated with commas. -- cgit From 1d81d7a268f5805bedc077f80582a89afe1bfe84 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Wed, 9 Aug 2023 15:33:53 -0700 Subject: feat(defaults): treat "•" as a list item prefix #24623 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Problem: Nvim docs use "•" as a list item prefix but `gw{motion}` doesn't format such lists by default. Solution: Change the 'comments' option to include "fb:•" by default. --- runtime/doc/options.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index fca73ddd1e..f04fb2fb51 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1374,7 +1374,7 @@ A jump table for the options with a short description can be found at |Q_op|. < Minimum value is 12, maximum value is 10000. *'comments'* *'com'* *E524* *E525* -'comments' 'com' string (default "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") +'comments' 'com' string (default "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-,fb:•") local to buffer A comma-separated list of strings that can start a comment line. See |format-comments|. See |option-backslash| about using backslashes to -- cgit From 0ba27bb51d3297aec43e78050cc3adcf6879db22 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Wed, 23 Aug 2023 16:32:15 +0800 Subject: vim-patch:9.0.1710: scrolloff options work slightly different Problem: sidescrolloff and scrolloff options work slightly different than other global-local options Solution: Make it behave consistent for all global-local options It was noticed, that sidescrolloff and scrolloff options behave differently in comparison to other global-local window options like 'listchars' So make those two behave like other global-local options. Also add some extra documentation for a few special local-window options. Add a few tests to make sure all global-local window options behave similar closes: vim/vim#12956 closes: vim/vim#12643 https://github.com/vim/vim/commit/4a8eb6e7a9df10f79bf95301ced012f0d6a13088 Co-authored-by: Christian Brabandt --- runtime/doc/options.txt | 47 ++++++++++++++++++++++++++++++++++++----------- 1 file changed, 36 insertions(+), 11 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index f04fb2fb51..eea9f2cf4b 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -189,6 +189,8 @@ opt+=val" the expansion is done before the adding or removing. Handling of local options *local-options* +Note: The following also applies to |global-local| options. + Some of the options only apply to a window or buffer. Each window or buffer has its own copy of this option, thus each can have its own value. This allows you to set 'list' in one window but not in another. And set @@ -238,6 +240,30 @@ The options local to a window are remembered for each buffer. This also happens when the buffer is not loaded, but they are lost when the buffer is wiped out |:bwipe|. +Special local window options *special-local-window-option* + +The following local window options won't be copied over when new windows are +created, thus they behave slightly differently: + + Option Reason ~ + 'previewwindow' there can only be a single one + 'scroll' specific to existing window + 'winfixheight' specific to existing window + 'winfixwidth' specific to existing window + +Special local buffer options *special-local-buffer-option* + +The following local buffer options won't be copied over when new buffers are +created, thus they behave slightly differently: + + Option Reason ~ + 'filetype' explicitly set by autocommands + 'syntax' explicitly set by autocommands + 'bufhidden' denote |special-buffers| + 'buftype' denote |special-buffers| + 'readonly' will be detected automatically + 'modified' will be detected automatically + *:setl* *:setlocal* :setl[ocal][!] ... Like ":set" but set only the value local to the current buffer or window. Not all options have a @@ -311,7 +337,6 @@ used. Thus it does the same as: > Note: In the future more global options can be made |global-local|. Using ":setlocal" on a global option might work differently then. - *option-value-function* Some options ('completefunc', 'omnifunc', 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to a function name or a function @@ -1070,7 +1095,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'bufhidden'* *'bh'* 'bufhidden' 'bh' string (default "") - local to buffer + local to buffer |special-local-buffer-option| This option specifies what happens when a buffer is no longer displayed in a window: follow the global 'hidden' option @@ -1102,7 +1127,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'buftype'* *'bt'* *E382* 'buftype' 'bt' string (default "") - local to buffer + local to buffer |special-local-buffer-option| The value of this option specifies the type of a buffer: normal buffer acwrite buffer will always be written with |BufWriteCmd|s @@ -2408,7 +2433,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'filetype'* *'ft'* 'filetype' 'ft' string (default "") - local to buffer + local to buffer |special-local-buffer-option| When this option is set, the FileType autocommand event is triggered. All autocommands that match with the value of this option will be executed. Thus the value of 'filetype' is used in place of the file @@ -4084,7 +4109,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'modified'* *'mod'* *'nomodified'* *'nomod'* 'modified' 'mod' boolean (default off) - local to buffer + local to buffer |special-local-buffer-option| When on, the buffer is considered to be modified. This option is set when: 1. A change was made to the text since it was last written. Using the @@ -4532,7 +4557,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'previewwindow'* *'pvw'* *'nopreviewwindow'* *'nopvw'* *E590* 'previewwindow' 'pvw' boolean (default off) - local to window + local to window |special-local-window-option| Identifies the preview window. Only one window can have this option set. It's normally not set directly, but by using one of the commands |:ptag|, |:pedit|, etc. @@ -4602,7 +4627,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'readonly'* *'ro'* *'noreadonly'* *'noro'* 'readonly' 'ro' boolean (default off) - local to buffer + local to buffer |special-local-buffer-option| If on, writes fail unless you use a '!'. Protects you from accidentally overwriting a file. Default on when Vim is started in read-only mode ("vim -R") or when the executable is called "view". @@ -4864,7 +4889,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'scroll'* *'scr'* 'scroll' 'scr' number (default half the window height) - local to window + local to window |special-local-window-option| Number of lines to scroll with CTRL-U and CTRL-D commands. Will be set to half the number of lines in the window when the window size changes. This may happen when enabling the |status-line| or @@ -6214,7 +6239,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'syntax'* *'syn'* 'syntax' 'syn' string (default "") - local to buffer + local to buffer |special-local-buffer-option| When this option is set, the syntax with this name is loaded, unless syntax highlighting has been switched off with ":syntax off". Otherwise this option does not always reflect the current syntax (the @@ -7081,7 +7106,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* 'winfixheight' 'wfh' boolean (default off) - local to window + local to window |special-local-window-option| Keep the window height when windows are opened or closed and 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |preview-window| and |quickfix-window|. @@ -7089,7 +7114,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* 'winfixwidth' 'wfw' boolean (default off) - local to window + local to window |special-local-window-option| Keep the window width when windows are opened or closed and 'equalalways' is set. Also for |CTRL-W_=|. The width may be changed anyway when running out of room. -- cgit From b1cfb299df2ef412339f594173ed23c75c090c8a Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Sat, 26 Aug 2023 08:35:05 +0800 Subject: docs: various clarifications (#24876) --- runtime/doc/options.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index eea9f2cf4b..e2ca9c1992 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4259,8 +4259,9 @@ A jump table for the options with a short description can be found at |Q_op|. 'mousescroll' string (default "ver:3,hor:6") global This option controls the number of lines / columns to scroll by when - scrolling with a mouse. The option is a comma separated list of parts. - Each part consists of a direction and a count as follows: + scrolling with a mouse wheel (|scroll-mouse-wheel|). The option is + a comma-separated list. Each part consists of a direction and a count + as follows: direction:count,direction:count Direction is one of either "hor" or "ver". "hor" controls horizontal scrolling and "ver" controls vertical scrolling. Count sets the amount -- cgit From 4b6023be7c2b132e7e6994adc73a7b79fbf40946 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Tue, 12 Sep 2023 07:37:05 +0800 Subject: vim-patch:596ad66d1ddb (#25102) runtime(doc): documentation updates This is a collection of various improvements to the help pages closes vim/vim#12790 https://github.com/vim/vim/commit/596ad66d1ddb742ef349e98eb06b8e4052f68f51 Co-authored-by: Christian Brabandt Co-authored-by: Houl Co-authored-by: Doug Kearns Co-authored-by: Adri Verhoef --- runtime/doc/options.txt | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index e2ca9c1992..68be0da2fd 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -240,7 +240,7 @@ The options local to a window are remembered for each buffer. This also happens when the buffer is not loaded, but they are lost when the buffer is wiped out |:bwipe|. -Special local window options *special-local-window-option* +Special local window options *local-noglobal* The following local window options won't be copied over when new windows are created, thus they behave slightly differently: @@ -251,7 +251,7 @@ created, thus they behave slightly differently: 'winfixheight' specific to existing window 'winfixwidth' specific to existing window -Special local buffer options *special-local-buffer-option* +Special local buffer options The following local buffer options won't be copied over when new buffers are created, thus they behave slightly differently: @@ -1095,7 +1095,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'bufhidden'* *'bh'* 'bufhidden' 'bh' string (default "") - local to buffer |special-local-buffer-option| + local to buffer |local-noglobal| This option specifies what happens when a buffer is no longer displayed in a window: follow the global 'hidden' option @@ -1127,7 +1127,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'buftype'* *'bt'* *E382* 'buftype' 'bt' string (default "") - local to buffer |special-local-buffer-option| + local to buffer |local-noglobal| The value of this option specifies the type of a buffer: normal buffer acwrite buffer will always be written with |BufWriteCmd|s @@ -2433,7 +2433,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'filetype'* *'ft'* 'filetype' 'ft' string (default "") - local to buffer |special-local-buffer-option| + local to buffer |local-noglobal| When this option is set, the FileType autocommand event is triggered. All autocommands that match with the value of this option will be executed. Thus the value of 'filetype' is used in place of the file @@ -4109,7 +4109,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'modified'* *'mod'* *'nomodified'* *'nomod'* 'modified' 'mod' boolean (default off) - local to buffer |special-local-buffer-option| + local to buffer |local-noglobal| When on, the buffer is considered to be modified. This option is set when: 1. A change was made to the text since it was last written. Using the @@ -4558,7 +4558,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'previewwindow'* *'pvw'* *'nopreviewwindow'* *'nopvw'* *E590* 'previewwindow' 'pvw' boolean (default off) - local to window |special-local-window-option| + local to window |local-noglobal| Identifies the preview window. Only one window can have this option set. It's normally not set directly, but by using one of the commands |:ptag|, |:pedit|, etc. @@ -4628,7 +4628,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'readonly'* *'ro'* *'noreadonly'* *'noro'* 'readonly' 'ro' boolean (default off) - local to buffer |special-local-buffer-option| + local to buffer |local-noglobal| If on, writes fail unless you use a '!'. Protects you from accidentally overwriting a file. Default on when Vim is started in read-only mode ("vim -R") or when the executable is called "view". @@ -4890,7 +4890,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'scroll'* *'scr'* 'scroll' 'scr' number (default half the window height) - local to window |special-local-window-option| + local to window |local-noglobal| Number of lines to scroll with CTRL-U and CTRL-D commands. Will be set to half the number of lines in the window when the window size changes. This may happen when enabling the |status-line| or @@ -6240,7 +6240,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'syntax'* *'syn'* 'syntax' 'syn' string (default "") - local to buffer |special-local-buffer-option| + local to buffer |local-noglobal| When this option is set, the syntax with this name is loaded, unless syntax highlighting has been switched off with ":syntax off". Otherwise this option does not always reflect the current syntax (the @@ -7107,7 +7107,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* 'winfixheight' 'wfh' boolean (default off) - local to window |special-local-window-option| + local to window |local-noglobal| Keep the window height when windows are opened or closed and 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |preview-window| and |quickfix-window|. @@ -7115,7 +7115,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* 'winfixwidth' 'wfw' boolean (default off) - local to window |special-local-window-option| + local to window |local-noglobal| Keep the window width when windows are opened or closed and 'equalalways' is set. Also for |CTRL-W_=|. The width may be changed anyway when running out of room. -- cgit From a6e74c1f0a2bbf03f5b99c167b549018f4c8fb0d Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Thu, 14 Sep 2023 06:05:27 +0200 Subject: docs: fix typos and other small fixes (#25005) Co-authored-by: nuid64 Co-authored-by: Mike Smith <10135646+mikesmithgh@users.noreply.github.com> Co-authored-by: XTY Co-authored-by: Empa Co-authored-by: kyu08 <49891479+kyu08@users.noreply.github.com> --- runtime/doc/options.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'runtime/doc/options.txt') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 68be0da2fd..f758782f09 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -2901,10 +2901,10 @@ A jump table for the options with a short description can be found at |Q_op|. n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20 In Normal et al. modes, use a block cursor with the default colors defined by the host - terminal. In Insert-likes modes, use + terminal. In Insert-like modes, use a vertical bar cursor with colors from - "Cursor" highlight group. In Replace-likes - modes, use a underline cursor with + "Cursor" highlight group. In Replace-like + modes, use an underline cursor with default colors. i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 In Insert and Command-line Insert mode, use a -- cgit From 2e92065686f62851318150a315591c30b8306a4b Mon Sep 17 00:00:00 2001 From: Gregory Anders <8965202+gpanders@users.noreply.github.com> Date: Thu, 14 Sep 2023 08:23:01 -0500 Subject: docs: replace 
 with ``` (#25136)

---
 runtime/doc/options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index f758782f09..e1518c58bb 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -945,7 +945,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 	backups if you don't care about losing the file.
 
 	Note that environment variables are not expanded.  If you want to use
-	$HOME you must expand it explicitly, e.g.: >
+	$HOME you must expand it explicitly, e.g.: >vim
 		:let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
 
 <	Note that the default also makes sure that "crontab -e" works (when a
-- 
cgit 


From 1b55f51d0d8468ca357514a868ac8e188b0c8722 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" 
Date: Wed, 20 Sep 2023 04:15:23 -0700
Subject: docs: misc #24561

fix #24699
fix #25253
---
 runtime/doc/options.txt | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index e1518c58bb..96bf2eef63 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -3235,9 +3235,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 			*'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
 'ignorecase' 'ic'	boolean	(default off)
 			global
-	Ignore case in search patterns.  Also used when searching in the tags
-	file.
-	Also see 'smartcase' and 'tagcase'.
+	Ignore case in search patterns, completion, and when searching the tags file.
+	See also 'smartcase' and 'tagcase'.
 	Can be overruled by using "\c" or "\C" in the pattern, see
 	|/ignorecase|.
 
-- 
cgit 


From f094db0e5ccaddca2b5db05bf9545d55f3eededf Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Thu, 21 Sep 2023 07:37:03 +0800
Subject: vim-patch:9.0.1921: not possible to use the jumplist like a stack
 (#25278)

Problem:  not possible to use the jumplist like a stack
Solution: Add the 'jumpoptions' setting to make the jumplist
          a stack.

Add an option for using jumplist like tag stack

related: vim/vim#7738
closes: vim/vim#13134

ported from NeoVim:

- https://neovim.io/doc/user/motion.html#jumplist-stack
- neovim/neovim@39094b3
- https://vi.stackexchange.com/questions/18344/how-to-change-jumplist-behavior

Based on the feedback in the previous PR, it looks like many people like
this option.

https://github.com/vim/vim/commit/87018255e3ad0f4dfa03e20318836d24af721caf

Co-authored-by: Yegappan Lakshmanan 
Co-authored-by: butwerenotthereyet <58348703+butwerenotthereyet@users.noreply.github.com>
---
 runtime/doc/options.txt | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 96bf2eef63..deb64bf18d 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -3569,12 +3569,11 @@ A jump table for the options with a short description can be found at |Q_op|.
 'jumpoptions' 'jop'	string	(default "")
 			global
 	List of words that change the behavior of the |jumplist|.
-	  stack         Make the jumplist behave like the tagstack or like a
-	                web browser.  Relative location of entries in the
-			jumplist is preserved at the cost of discarding
-			subsequent entries when navigating backwards in the
-			jumplist and then jumping to a location.
-			|jumplist-stack|
+	  stack         Make the jumplist behave like the tagstack.
+			Relative location of entries in the jumplist is
+			preserved at the cost of discarding subsequent entries
+			when navigating backwards in the jumplist and then
+			jumping to a location.  |jumplist-stack|
 
 	  view          When moving through the jumplist, |changelist|,
 			|alternate-file| or using |mark-motions| try to
-- 
cgit 


From f7da4722570617bd8927e7aa533fa9a608c45bba Mon Sep 17 00:00:00 2001
From: bfredl 
Date: Sat, 23 Sep 2023 16:42:47 +0200
Subject: refactor(options)!: graduate shortmess+=f flag

Not everything needs to be crazy overconfigurable.

Also fixes a warning in latest clang which didn't approve of
the funky math switch statement in  append_arg_number
---
 runtime/doc/options.txt | 1 -
 1 file changed, 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index deb64bf18d..9b4f36cbce 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -5391,7 +5391,6 @@ A jump table for the options with a short description can be found at |Q_op|.
 	messages, for example  with CTRL-G, and to avoid some other messages.
 	It is a list of flags:
 	 flag	meaning when present	~
-	  f	use "(3 of 5)" instead of "(file 3 of 5)"		*shm-f*
 	  i	use "[noeol]" instead of "[Incomplete last line]"	*shm-i*
 	  l	use "999L, 888B" instead of "999 lines, 888 bytes"	*shm-l*
 	  m	use "[+]" instead of "[Modified]"			*shm-m*
-- 
cgit 


From 046c9a83f7ed2694c19d915a63ef0dfed9d29dc5 Mon Sep 17 00:00:00 2001
From: tj-moody <92702993+tj-moody@users.noreply.github.com>
Date: Sat, 23 Sep 2023 22:49:47 -0400
Subject: fix(ui): always use stl/stlnc fillchars when drawing statusline
 (#25267)

---
 runtime/doc/options.txt | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 9b4f36cbce..b26c181f28 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -2465,8 +2465,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	and the value of that item:
 
 	  item		default		Used for ~
-	  stl		' ' or '^'	statusline of the current window
-	  stlnc		' ' or '='	statusline of the non-current windows
+	  stl		' '		statusline of the current window
+	  stlnc		' '		statusline of the non-current windows
 	  wbr		' '		window bar
 	  horiz		'─' or '-'	horizontal separators |:split|
 	  horizup	'┴' or '-'	upwards facing horizontal separator
@@ -2485,9 +2485,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 	  eob		'~'		empty lines at the end of a buffer
 	  lastline	'@'		'display' contains lastline/truncate
 
-	Any one that is omitted will fall back to the default.  For "stl" and
-	"stlnc" the space will be used when there is highlighting, '^' or '='
-	otherwise.
+	Any one that is omitted will fall back to the default.
 
 	Note that "horiz", "horizup", "horizdown", "vertleft", "vertright" and
 	"verthoriz" are only used when 'laststatus' is 3, since only vertical
-- 
cgit 


From 6fb1e0d499b33534152f09744f967f355a9e2a24 Mon Sep 17 00:00:00 2001
From: Gregory Anders 
Date: Sun, 24 Sep 2023 09:09:18 -0500
Subject: docs: remove "f" from default 'shortmess' value

The "f" flag was removed in f7da4722570617bd8927e7aa533fa9a608c45bba.
The value of the "f" flag is no longer listed in the 'shortmess'
description and it cannot be disabled, so having it in the default value
is pointless and confusing.
---
 runtime/doc/options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index b26c181f28..5e91bd8666 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -5383,7 +5383,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 	function to get the effective shiftwidth value.
 
 					*'shortmess'* *'shm'* *E1336*
-'shortmess' 'shm'	string	(default "filnxtToOCF")
+'shortmess' 'shm'	string	(default "ilnxtToOCF")
 			global
 	This option helps to avoid all the |hit-enter| prompts caused by file
 	messages, for example  with CTRL-G, and to avoid some other messages.
-- 
cgit 


From c3d1d9445c70846d43d1f091ee0762e16513e225 Mon Sep 17 00:00:00 2001
From: bfredl 
Date: Mon, 25 Sep 2023 12:21:35 +0200
Subject: refactor(options)!: graduate some more shortmess flags

A lot of updated places in the docs were already incorrect since long
since they did not reflect the default behaviour.

"[dos format]" could've been argued being better for discoverability
but that ship has already sailed as it is no longer displayed by default.
---
 runtime/doc/options.txt | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 5e91bd8666..0bbbc95141 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -5383,22 +5383,17 @@ A jump table for the options with a short description can be found at |Q_op|.
 	function to get the effective shiftwidth value.
 
 					*'shortmess'* *'shm'* *E1336*
-'shortmess' 'shm'	string	(default "ilnxtToOCF")
+'shortmess' 'shm'	string	(default "ltToOCF")
 			global
 	This option helps to avoid all the |hit-enter| prompts caused by file
 	messages, for example  with CTRL-G, and to avoid some other messages.
 	It is a list of flags:
 	 flag	meaning when present	~
-	  i	use "[noeol]" instead of "[Incomplete last line]"	*shm-i*
 	  l	use "999L, 888B" instead of "999 lines, 888 bytes"	*shm-l*
 	  m	use "[+]" instead of "[Modified]"			*shm-m*
-	  n	use "[New]" instead of "[New File]"			*shm-n*
 	  r	use "[RO]" instead of "[readonly]"			*shm-r*
 	  w	use "[w]" instead of "written" for file write message	*shm-w*
 		and "[a]" instead of "appended" for ':w >> file' command
-	  x	use "[dos]" instead of "[dos format]", "[unix]"		*shm-x*
-		instead of "[unix format]" and "[mac]" instead of "[mac
-		format]"
 	  a	all of the above abbreviations				*shm-a*
 
 	  o	overwrite message for writing a file with subsequent	*shm-o*
-- 
cgit 


From 86b7d8a9f54d572e6866d6a24476d2369a288f79 Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Thu, 28 Sep 2023 05:22:09 +0800
Subject: vim-patch:5277cfaf8afe (#25397)

runtime(doc): mention mouse scrolling in scrollbind-quickadj (vim/vim#13190)

https://github.com/vim/vim/commit/5277cfaf8afe847b7d4dcde6057fbecb001ab64e
---
 runtime/doc/options.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 0bbbc95141..84cff775f6 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -4909,9 +4909,9 @@ A jump table for the options with a short description can be found at |Q_op|.
 			*'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
 'scrollbind' 'scb'	boolean	(default off)
 			local to window
-	See also |scroll-binding|.  When this option is set, the current
-	window scrolls as other scrollbind windows (windows that also have
-	this option set) scroll.  This option is useful for viewing the
+	See also |scroll-binding|.  When this option is set, scrolling the
+	current window also scrolls other scrollbind windows (windows that
+	also have this option set).  This option is useful for viewing the
 	differences between two versions of a file, see 'diff'.
 	See |'scrollopt'| for options that determine how this option should be
 	interpreted.
-- 
cgit 


From f06af5e66981095f3244f67d1587ce7e9853eb4c Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Sat, 30 Sep 2023 08:13:58 +0800
Subject: vim-patch:9.0.1958: cannot complete option values

Problem:  cannot complete option values
Solution: Add completion functions for several options

Add cmdline tab-completion for setting string options

Add tab-completion for setting string options on the cmdline using
`:set=` (along with `:set+=` and `:set-=`).

The existing tab completion for setting options currently only works
when nothing is typed yet, and it only fills in with the existing value,
e.g. when the user does `:set diffopt=` it will be completed to
`set diffopt=internal,filler,closeoff` and nothing else. This isn't too
useful as a user usually wants auto-complete to suggest all the possible
values, such as 'iblank', or 'algorithm:patience'.

For set= and set+=, this adds a new optional callback function for each
option that can be invoked when doing completion. This allows for each
option to have control over how completion works. For example, in
'diffopt', it will suggest the default enumeration, but if `algorithm:`
is selected, it will further suggest different algorithm types like
'meyers' and 'patience'. When using set=, the existing option value will
be filled in as the first choice to preserve the existing behavior. When
using set+= this won't happen as it doesn't make sense.

For flag list options (e.g. 'mouse' and 'guioptions'), completion will
take into account existing typed values (and in the case of set+=, the
existing option value) to make sure it doesn't suggest duplicates.

For set-=, there is a new `ExpandSettingSubtract` function which will
handle flag list and comma-separated options smartly, by only suggesting
values that currently exist in the option.

Note that Vim has some existing code that adds special handling for
'filetype', 'syntax', and misc dir options like 'backupdir'. This change
preserves them as they already work, instead of converting to the new
callback API for each option.

closes: vim/vim#13182

https://github.com/vim/vim/commit/900894b09a95398dfc75599e9f0aa2ea25723384

Co-authored-by: Yee Cheng Chin 
---
 runtime/doc/options.txt | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 84cff775f6..35fb08a9a4 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -52,14 +52,16 @@ achieve special effects.  These options come in three forms:
 			  'lines'
 			Warning: This may have a lot of side effects.
 
-						*:set-args* *E487* *E521*
+						*:set-args* *:set=* *E487* *E521*
 :se[t] {option}={value}		or
 :se[t] {option}:{value}
 			Set string or number option to {value}.
 			For numeric options the value can be given in decimal,
 			hex (preceded with 0x) or octal (preceded with '0').
 			The old value can be inserted by typing 'wildchar' (by
-			default this is a ).  See |cmdline-completion|.
+			default this is a ).  Many string options with
+			fixed syntax also support completing known values.
+			See |cmdline-completion| and |complete-set-option|.
 			White space between {option} and '=' is allowed and
 			will be ignored.  White space between '=' and {value}
 			is not allowed.
@@ -93,6 +95,9 @@ achieve special effects.  These options come in three forms:
 			When the option is a list of flags, {value} must be
 			exactly as they appear in the option.  Remove flags
 			one by one to avoid problems.
+			The individual values from a comma separated list or
+			list of flags can be inserted by typing 'wildchar'.
+			See |complete-set-option|.
 			Also see |:set-args| above.
 
 The {option} arguments to ":set" may be repeated.  For example: >
-- 
cgit 


From 19b49b063c28f7d246bf1b452e5ad59a44345c9d Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Tue, 3 Oct 2023 06:21:59 +0800
Subject: vim-patch:20f48d5b2ddb

runtime(doc): mention how to disable folding in diff mode (vim/vim#13242)

https://github.com/vim/vim/commit/20f48d5b2ddb9fdc29e83f0da6f31f895eaeab47

Co-authored-by: dundargoc <33953936+dundargoc@users.noreply.github.com>
---
 runtime/doc/options.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 35fb08a9a4..bc207d7755 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1966,7 +1966,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 				When omitted a context of six lines is used.
 				When using zero the context is actually one,
 				since folds require a line in between, also
-				for a deleted line.
+				for a deleted line. Set it to a very large
+				value (999999) to disable folding completely.
 				See |fold-diff|.
 
 		iblank		Ignore changes where lines are all blank.  Adds
-- 
cgit 


From 1dd700a8d9275439fbc71ac5adeb59914bdbd5cf Mon Sep 17 00:00:00 2001
From: Leonardo Mello 
Date: Mon, 18 Sep 2023 16:50:47 -0300
Subject: fix: gf fails on "foo/bar.txt:1:2" on Windows

Problem:
On Windows, "gf" fails on a filepath that has a line:column suffix.
Example:

    E447: Can't find file "src/app/core/services/identity/identity.service.ts:64:23"

Solution:
- Remove ":" from 'isfname' on Windows. Colon is not a valid filename
  character (except for the drive-letter).
- Handle drive letters specially in file_name_in_line().

Fixes #25160
---
 runtime/doc/options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index bc207d7755..283c1e3612 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -3453,7 +3453,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 
 						*'isfname'* *'isf'*
 'isfname' 'isf'		string	(default for Windows:
-                             "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
+                             "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],@-@,!,~,="
                             otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
 			global
 	The characters specified by this option are included in file names and
-- 
cgit 


From c80a3976cb34c2b3c7f6f01e9ad2db41a4f67796 Mon Sep 17 00:00:00 2001
From: Maria José Solano 
Date: Mon, 9 Oct 2023 15:34:48 -0700
Subject: docs: miscellaneous doc and type fixes (#25554)

---
 runtime/doc/options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 283c1e3612..87cf811d63 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -2552,7 +2552,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 	    "auto":       resize to the minimum amount of folds to display.
 	    "auto:[1-9]": resize to accommodate multiple folds up to the
 			  selected level
-	    0:            to disable foldcolumn
+	    "0":          to disable foldcolumn
 	    "[1-9]":      to display a fixed number of columns
 	See |folding|.
 
-- 
cgit 


From f5eabaa9407ae3d1ccf6592337453c423eff3d9a Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Tue, 10 Oct 2023 08:22:32 +0800
Subject: fix(path): restore space separation in 'path' (#25571)

Removing this behavior causes more inconsistencies and bugs.
---
 runtime/doc/options.txt | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 87cf811d63..07f4eb80c5 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -4499,6 +4499,10 @@ A jump table for the options with a short description can be found at |Q_op|.
 	option may be relative or absolute.
 	- Use commas to separate directory names: >
 		:set path=.,/usr/local/include,/usr/include
+<	- Spaces can also be used to separate directory names.  To have a
+	  space in a directory name, precede it with an extra backslash, and
+	  escape the space: >
+		:set path=.,/dir/with\\\ space
 <	- To include a comma in a directory name precede it with an extra
 	  backslash: >
 		:set path=.,/dir/with\\,comma
-- 
cgit 


From c40a1c0f41ad2557b1e1e1850244eca2d895a07d Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Tue, 10 Oct 2023 09:15:21 +0800
Subject: vim-patch:9.0.2009: cmdline-completion for comma-separated options
 wrong (#25569)

Problem:  cmdline-completion for comma-separated options wrong
Solution: Fix command-line expansions for options with filenames with
          commas

Fix command-line expansions for options with filenames with commas

Cmdline expansion for option values that take a comma-separated list
of file names is currently not handling file names with commas as the
commas are not escaped. For such options, the commas in file names need
to be escaped (to differentiate from a comma that delimit the list
items). The escaped comma is unescaped in `copy_option_part()` during
option parsing.

Fix as follows:
- Cmdline completion for option values with comma-separated file/folder
  names will not start a new match when seeing `\\,` and will instead
  consider it as one value.
- File/folder regex matching will strip the `\\` when seeing `\\,` to
  make sure it can match the correct files/folders.
- The expanded value will escape `,` with `\\,`, similar to how spaces
  are escaped to make sure the option value is correct on the cmdline.

This fix also takes into account the fact that Win32 Vim handles file
name escaping differently. Typing '\,' for a file name results in it
being handled literally but in other platforms '\,' is interpreted as a
simple ',' and commas need to be escaped using '\\,' instead.

Also, make sure this new logic only applies to comma-separated options
like 'path'. Non-list options like 'set makeprg=' and regular ex
commands like `:edit ` do not require escaping and will continue to
work.

Also fix up documentation to be clearer. The original docs are slightly
misleading in how it discusses triple slashes for 'tags'.

closes: vim/vim#13303
related: vim/vim#13301

https://github.com/vim/vim/commit/54844857fd6933fa4f6678e47610c4b9c9f7a091

Co-authored-by: Yee Cheng Chin 
---
 runtime/doc/options.txt | 26 +++++++++++++++++++++-----
 1 file changed, 21 insertions(+), 5 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 07f4eb80c5..e2af4d5bc1 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -136,10 +136,26 @@ To include white space in a string option value it has to be preceded with a
 backslash.  To include a backslash you have to use two.  Effectively this
 means that the number of backslashes in an option value is halved (rounded
 down).
+In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
+backslashes instead becuase they can be separated by either commas or spaces.
+Comma-separated options like 'backupdir' and 'tags' will also require commas
+to be escaped with two backslashes, whereas this is not needed for
+non-comma-separated ones like 'makeprg'.
+When setting options using |:let| and |literal-string|, you need to use one
+fewer layer of backslash.
 A few examples: >
-   :set tags=tags\ /usr/tags	    results in "tags /usr/tags"
-   :set tags=tags\\,file	    results in "tags\,file"
-   :set tags=tags\\\ file	    results in "tags\ file"
+   :set makeprg=make\ file	    results in "make file"
+   :let &makeprg='make file'	    (same as above)
+   :set makeprg=make\\\ file	    results in "make\ file"
+   :set tags=tags\ /usr/tags	    results in "tags" and "/usr/tags"
+   :set tags=tags\\\ file	    results in "tags file"
+   :let &tags='tags\ file'	    (same as above)
+
+   :set makeprg=make,file	    results in "make,file"
+   :set makeprg=make\\,file	    results in "make\,file"
+   :set tags=tags,file		    results in "tags" and "file"
+   :set tags=tags\\,file	    results in "tags,file"
+   :let &tags='tags\,file'	    (same as above)
 
 The "|" character separates a ":set" command from a following command.  To
 include the "|" in the option value, use "\|" instead.  This example sets the
@@ -6426,8 +6442,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 'tags' 'tag'		string	(default "./tags;,tags")
 			global or local to buffer |global-local|
 	Filenames for the tag command, separated by spaces or commas.  To
-	include a space or comma in a file name, precede it with a backslash
-	(see |option-backslash| about including spaces and backslashes).
+	include a space or comma in a file name, precede it with backslashes
+	(see |option-backslash| about including spaces/commas and backslashes).
 	When a file name starts with "./", the '.' is replaced with the path
 	of the current file.  But only when the 'd' flag is not included in
 	'cpoptions'.  Environment variables are expanded |:set_env|.  Also see
-- 
cgit 


From 20dacacf374d93d9bef45626d5851265d1075841 Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Sat, 14 Oct 2023 19:28:41 +0800
Subject: vim-patch:2bbd0d30eebd (#25637)

runtime(doc): Improve command-line completion docs (vim/vim#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

https://github.com/vim/vim/commit/2bbd0d30eebdea66c0da3895e83d999ed6ad83fb

Co-authored-by: Yee Cheng Chin 
---
 runtime/doc/options.txt | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index e2af4d5bc1..6ca2de8097 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -3255,8 +3255,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 			*'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
 'ignorecase' 'ic'	boolean	(default off)
 			global
-	Ignore case in search patterns, completion, and when searching the tags file.
-	See also 'smartcase' and 'tagcase'.
+	Ignore case in search patterns, |cmdline-completion|, when
+	searching in the tags file, and |expr-==|.
 	Can be overruled by using "\c" or "\C" in the pattern, see
 	|/ignorecase|.
 
@@ -6975,18 +6975,21 @@ A jump table for the options with a short description can be found at |Q_op|.
 	a completion.
 
 	While the menu is active these keys have special meanings:
-
-	CTRL-Y		- accept the currently selected match and stop
-			  completion.
-	CTRL-E		- end completion, go back to what was there before
-			  selecting a match.
+	CTRL-P		- go to the previous entry
+	CTRL-N		- go to the next entry
 	 	- select previous/next match (like CTRL-P/CTRL-N)
+		- select a match several entries back
+		- select a match several entries further
+			- in filename/menu name completion: move up into
+			  parent directory or parent menu.
 			- in filename/menu name completion: move into a
 			  subdirectory or submenu.
 			- in menu completion, when the cursor is just after a
 			  dot: move into a submenu.
-			- in filename/menu name completion: move up into
-			  parent directory or parent menu.
+	CTRL-E		- end completion, go back to what was there before
+			  selecting a match.
+	CTRL-Y		- accept the currently selected match and stop
+			  completion.
 
 	If you want  and  to move the cursor instead of selecting
 	a different match, use this: >
-- 
cgit 


From aa62579a684277d86b1f4a7588464e0ec4227b94 Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Sun, 15 Oct 2023 09:05:27 +0800
Subject: docs: restore accidentally removed line in :h 'ignorecase' (#25651)

---
 runtime/doc/options.txt | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 6ca2de8097..d94a9a131d 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -3257,6 +3257,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 			global
 	Ignore case in search patterns, |cmdline-completion|, when
 	searching in the tags file, and |expr-==|.
+	Also see 'smartcase' and 'tagcase'.
 	Can be overruled by using "\c" or "\C" in the pattern, see
 	|/ignorecase|.
 
-- 
cgit 


From e5a424d78ed72613dd5ccc161578f9f6f853a0e8 Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Sun, 15 Oct 2023 17:02:17 +0800
Subject: vim-patch:9.0.2030: no max callback recursion limit (#25655)

Problem:  no max callback recursion limit
Solution: bail out, if max call recursion for callback functions
          has been reached.

This checks the 'maxfuncdepth' setting and throws E169 when a callback
function recursively calls itself.

closes: vim/vim#13337
closes: vim/vim#13339

https://github.com/vim/vim/commit/47510f3d6598a1218958c03ed11337a43b73f48d

Co-authored-by: Christian Brabandt 
---
 runtime/doc/options.txt | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index d94a9a131d..e734b62020 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -4024,6 +4024,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 	Increasing this limit above 200 also changes the maximum for Ex
 	command recursion, see |E169|.
 	See also |:function|.
+	Also used for maximum depth of callback functions.
 
 					*'maxmapdepth'* *'mmd'* *E223*
 'maxmapdepth' 'mmd'	number	(default 1000)
-- 
cgit 


From 272ef271153b0f66410b0e59ce31e05d211b44fd Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Tue, 17 Oct 2023 22:43:42 +0800
Subject: vim-patch:9.0.2035: [security] use-after-free with wildmenu (#25687)

Problem:  [security] use-after-free with wildmenu
Solution: properly clean up the wildmenu when exiting

Fix wildchar/wildmenu/pum memory corruption with special wildchar's

Currently, using `wildchar=` or `wildchar=` can lead to a
memory corruption if using wildmenu+pum, or wrong states if only using
wildmenu. This is due to the code only using one single place inside the
cmdline process loop to perform wild menu clean up (by checking
`end_wildmenu`) but there are other odd situations where the loop could
have exited and we need a post-loop clean up just to be sure. If the
clean up was not done you would have a stale popup menu referring to
invalid memory, or if not using popup menu, incorrect status line (if
`laststatus=0`).

For example, if you hit `` two times when it's wildchar, there's a
hard-coded behavior to exit command-line as a failsafe for user, and if
you hit `` it will also exit command-line, but the clean
up code would not have hit because of specialized `` handling.

Fix Ctrl-E / Ctrl-Y to not cancel/accept wildmenu if they are also
used for 'wildchar'/'wildcharm'. Currently they don't behave properly,
and also have potentially memory unsafe behavior as the logic is
currently not accounting for this situation and try to do both.
(Previous patch that addressed this: vim/vim#11677)

Also, correctly document Escape key behavior (double-hit it to escape)
in wildchar docs as it's previously undocumented.

In addition, block known invalid chars to be set in `wildchar` option,
such as Ctrl-C and ``. This is just to make it clear to the user
they shouldn't be set, and is not required for this bug fix.

closes: vim/vim#13361

https://github.com/vim/vim/commit/8f4fb007e4d472b09ff6bed9ffa485e0c3093699

Co-authored-by: Yee Cheng Chin 
---
 runtime/doc/options.txt | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index e734b62020..c8ea5ce67f 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -6920,6 +6920,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	The character is not recognized when used inside a macro.  See
 	'wildcharm' for that.
 	Some keys will not work, such as CTRL-C,  and Enter.
+	 can be used, but hitting it twice in a row will still exit
+	command-line as a failsafe measure.
 	Although 'wc' is a number option, you can set it to a special key: >
 		:set wc=
 <
-- 
cgit 


From ae4ca4edf89ece433b61e8bf92c412298b58d9ea Mon Sep 17 00:00:00 2001
From: glepnir 
Date: Fri, 13 Oct 2023 14:49:01 +0800
Subject: feat(complete): support f flag for complete buffer part

---
 runtime/doc/options.txt | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index c8ea5ce67f..9dc382948c 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1458,6 +1458,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 		|i_CTRL-X_CTRL-D|
 	]	tag completion
 	t	same as "]"
+	f	scan the buffer names (as opposed to buffer contents)
 
 	Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
 	not executed, this may lead to unexpected completions from some files
-- 
cgit 


From bfe8a39512bc4dbf4921c56158c61a172e8f10cf Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Thu, 26 Oct 2023 06:41:54 +0800
Subject: vim-patch:partial:5985879e3c36 (#25780)

runtime(doc): Fix typos in several documents (vim/vim#13420)

* Fix typos in several documents
* Update runtime/doc/terminal.txt

https://github.com/vim/vim/commit/5985879e3c36383155f84649fa42d06813a1893e

Skip runtime/doc/indent.txt: not ported yet

Co-authored-by: h_east 
Co-authored-by: K.Takata 
---
 runtime/doc/options.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 9dc382948c..3864b4f25b 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -52,7 +52,7 @@ achieve special effects.  These options come in three forms:
 			  'lines'
 			Warning: This may have a lot of side effects.
 
-						*:set-args* *:set=* *E487* *E521*
+					    *:set-args* *:set=* *E487* *E521*
 :se[t] {option}={value}		or
 :se[t] {option}:{value}
 			Set string or number option to {value}.
@@ -6224,7 +6224,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 	This option controls the behavior when switching between buffers.
 	This option is checked, when
 	- jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
-	  etc.)
+	  etc.).
 	- jumping to a tag using the |:stag| command.
 	- opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
 	- jumping to a buffer using a buffer split command (e.g.  |:sbuffer|,
-- 
cgit 


From a2a1a65b98ad88d69906b9c372dca1c3063100ef Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Sun, 29 Oct 2023 06:15:13 +0800
Subject: vim-patch:8ebdbc9e6d80 (#25816)

runtime(doc): all secure options should note this restriction in the documentation (vim/vim#13448)

Problem:  Not all secure options document their status
Solution: Describe secure context :set restrictions in each help entry

https://github.com/vim/vim/commit/8ebdbc9e6d80b707c2b2d923e702dc86bf902923

Co-authored-by: dkearns 
---
 runtime/doc/options.txt | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 3864b4f25b..56926aec69 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1214,6 +1214,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	current working directory to the |$HOME| directory like in Unix.
 	When off, those commands just print the current directory name.
 	On Unix this option has no effect.
+	This option cannot be set from a |modeline| or in the |sandbox|, for
+	security reasons.
 
 					*'cdpath'* *'cd'* *E344* *E346*
 'cdpath' 'cd'		string	(default equivalent to $CDPATH or ",,")
@@ -4095,7 +4097,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 <	If you have less than 512 Mbyte |:mkspell| may fail for some
 	languages, no matter what you set 'mkspellmem' to.
 
-	This option cannot be set from a |modeline| or in the |sandbox|.
+	This option cannot be set from a |modeline| or in the |sandbox|, for
+	security reasons.
 
 				*'modeline'* *'ml'* *'nomodeline'* *'noml'*
 'modeline' 'ml'		boolean	(default on (off for root))
@@ -4475,6 +4478,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 			global
 	Directories used to find packages.
 	See |packages| and |packages-runtimepath|.
+	This option cannot be set from a |modeline| or in the |sandbox|, for
+	security reasons.
 
 						*'paragraphs'* *'para'*
 'paragraphs' 'para'	string	(default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
@@ -4487,6 +4492,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 			global
 	Expression which is evaluated to apply a patch to a file and generate
 	the resulting new version of the file.  See |diff-patchexpr|.
+	This option cannot be set from a |modeline| or in the |sandbox|, for
+	security reasons.
 
 					*'patchmode'* *'pm'* *E205* *E206*
 'patchmode' 'pm'	string	(default "")
@@ -5382,6 +5389,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	When 'shellxquote' is set to "(" then the characters listed in this
 	option will be escaped with a '^' character.  This makes it possible
 	to execute most external commands with cmd.exe.
+	This option cannot be set from a |modeline| or in the |sandbox|, for
+	security reasons.
 
 						*'shellxquote'* *'sxq'*
 'shellxquote' 'sxq'	string	(default "", Windows: "\"")
@@ -6429,6 +6438,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	function and an example.  The value can be the name of a function, a
 	|lambda| or a |Funcref|. See |option-value-function| for more
 	information.
+	This option cannot be set from a |modeline| or in the |sandbox|, for
+	security reasons.
 
 						*'taglength'* *'tl'*
 'taglength' 'tl'	number	(default 0)
@@ -6817,6 +6828,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	Setting 'verbosefile' to a new value is like making it empty first.
 	The difference with |:redir| is that verbose messages are not
 	displayed when 'verbosefile' is set.
+	This option cannot be set from a |modeline| or in the |sandbox|, for
+	security reasons.
 
 						*'viewdir'* *'vdir'*
 'viewdir' 'vdir'	string	(default "$XDG_STATE_HOME/nvim/view//")
-- 
cgit 


From 2dc9ceb99c018b15dcf0c443cad46efecccaf94e Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Sun, 29 Oct 2023 09:02:32 +0100
Subject: docs: small fixes (#25585)

Co-authored-by: tmummert 
Co-authored-by: parikshit adhikari 
---
 runtime/doc/options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 56926aec69..b2a020cf9d 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -137,7 +137,7 @@ backslash.  To include a backslash you have to use two.  Effectively this
 means that the number of backslashes in an option value is halved (rounded
 down).
 In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
-backslashes instead becuase they can be separated by either commas or spaces.
+backslashes instead because they can be separated by either commas or spaces.
 Comma-separated options like 'backupdir' and 'tags' will also require commas
 to be escaped with two backslashes, whereas this is not needed for
 non-comma-separated ones like 'makeprg'.
-- 
cgit 


From f7b2ea59a633309aba1ca5286e33d789a45cb13f Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Thu, 9 Nov 2023 06:34:34 +0800
Subject: vim-patch:9.0.2095: statusline may look different than expected
 (#25941)

Problem:  statusline may look different than expected
Solution: do not check for highlighting of stl and stlnc characters

statusline fillchar may be different than expected

If the highlighting group for the statusline for the current window
|hl-StatusLine| or the non-current window |hl-StatusLineNC| are cleared
(or do not differ from each other), than Vim will use the hard-coded
fallback values '^' (for the non-current windows) or '=' (for the
current window).  I believe this was done, to make sure the statusline
will always be visible and be distinguishable from the rest of the
window.

However, this may be unexpected, if a user explicitly defined those
fillchar characters just to notice that those values are then not used
by Vim.

So, let's assume users know what they are doing and just always return
the configured stl and stlnc values.  And if they want the statusline to
be non-distinguishable from the rest of the window space, so be it.  It
is their responsibility and Vim shall not know better what to use.

fixes: vim/vim#13366
closes: vim/vim#13488

https://github.com/vim/vim/commit/6a650bf696f1df3214b3d788947447c5bbf1a77d

Co-authored-by: Christian Brabandt 
---
 runtime/doc/options.txt | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index b2a020cf9d..d92e528214 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -2521,10 +2521,8 @@ A jump table for the options with a short description can be found at |Q_op|.
 	default to single-byte alternatives.
 
 	Example: >
-	    :set fillchars=stl:^,stlnc:=,vert:│,fold:·,diff:-
-<	This is similar to the default, except that these characters will also
-	be used when there is highlighting.
-
+	    :set fillchars=stl:\ ,stlnc:\ ,vert:│,fold:·,diff:-
+<
 	For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
 	single-byte and multibyte characters are supported.  But double-width
 	characters are not supported.
-- 
cgit 


From 2494009885b6d8073017ee3c7e16bcc1796c4c99 Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Sun, 12 Nov 2023 07:49:57 +0800
Subject: vim-patch:1b08d2cd0789 (#25993)

runtime(doc): clarify when formatoptions applies

closes: vim/vim#13503

https://github.com/vim/vim/commit/1b08d2cd0789fd9aaae148a64ff46342730022d7

Co-authored-by: Christian Brabandt 
---
 runtime/doc/options.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index d92e528214..6a71ad296c 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -2774,8 +2774,9 @@ A jump table for the options with a short description can be found at |Q_op|.
 'formatoptions' 'fo'	string	(default "tcqj")
 			local to buffer
 	This is a sequence of letters which describes how automatic
-	formatting is to be done.  See |fo-table|.  Commas can be inserted for
-	readability.
+	formatting is to be done.
+	See |fo-table| for possible values and |gq| for how to format text.
+	Commas can be inserted for readability.
 	To avoid problems with flags that are added in the future, use the
 	"+=" and "-=" feature of ":set" |add-option-flags|.
 
-- 
cgit 


From 6d14f3ddab33144966e46487b6039440ac7c43f2 Mon Sep 17 00:00:00 2001
From: zeertzjq 
Date: Mon, 13 Nov 2023 06:33:34 +0800
Subject: vim-patch:9.0.2103: recursive callback may cause issues on some archs
 (#26013)

Problem:  recursive callback may cause issues on some archs
Solution: Decrease the limit drastically to 20

Recursive callback limit causes problems on some architectures

Since commit 47510f3d6598a1218958c03ed11337a43b73f48d we have a test
that causes a recursive popup callback function to be executed. However
it seems the current limit of 'maxfuncdepth' option value is still too
recursive for some 32bit architectures (e.g. 32bit ARM).

So instead of allowing a default limit of 100 (default value for
'maxfuncdepth'), let's reduce this limit to 20. I don't think there is a
use case where one would need such a high recursive callback limit and a
limit of 20 seems reasonable (although it is currently hard-coded).

closes: vim/vim#13495
closes: vim/vim#13502

https://github.com/vim/vim/commit/2076463e383901cef44685aaf4b63e4306444f9e

Co-authored-by: Christian Brabandt 
---
 runtime/doc/options.txt | 1 -
 1 file changed, 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 6a71ad296c..7f2eb9da07 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -4026,7 +4026,6 @@ A jump table for the options with a short description can be found at |Q_op|.
 	Increasing this limit above 200 also changes the maximum for Ex
 	command recursion, see |E169|.
 	See also |:function|.
-	Also used for maximum depth of callback functions.
 
 					*'maxmapdepth'* *'mmd'* *E223*
 'maxmapdepth' 'mmd'	number	(default 1000)
-- 
cgit 


From 5b45efbee6ebb64269469b636baac5248e83421f Mon Sep 17 00:00:00 2001
From: Ploum <1233155+ploum@users.noreply.github.com>
Date: Tue, 14 Nov 2023 11:56:50 +0100
Subject: fix(defaults): set 'fsync' #26034

Problem:
'nofsync' may lose data if the system has a hard shutdown. #9888

Solution:
Change default to 'fsync'. This may be revisited in the future when
'nofsync' can be made safer.
---
 runtime/doc/options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 7f2eb9da07..603b777f55 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -2796,7 +2796,7 @@ A jump table for the options with a short description can be found at |Q_op|.
 	security reasons.
 
 					*'fsync'* *'fs'* *'nofsync'* *'nofs'*
-'fsync' 'fs'		boolean	(default off)
+'fsync' 'fs'		boolean	(default on)
 			global
 	When on, the OS function fsync() will be called after saving a file
 	(|:write|, |writefile()|, …), |swap-file|, |undo-persistence| and |shada-file|.
-- 
cgit 


From ac8ed77afb359694a716501d9e87b0c9949b2445 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Tue, 14 Nov 2023 08:53:58 -0600
Subject: feat(tui): add 'termsync' option (#25871)

The 'termsync' option enables a mode (provided the underlying terminal
supports it) where all screen updates during a redraw cycle are buffered
and drawn together when the redraw is complete. This eliminates tearing
or flickering in cases where Nvim redraws slower than the terminal
redraws the screen.
---
 runtime/doc/options.txt | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 603b777f55..07326c8c13 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -6523,6 +6523,14 @@ A jump table for the options with a short description can be found at |Q_op|.
 
 	   C1	    Control characters 0x80...0x9F
 
+					*'termsync'* *'notermsync'*
+'termsync'		boolean	(default on)
+			global
+	If the host terminal supports it, buffer all screen updates
+	made during a redraw cycle so that each screen is displayed in
+	the terminal all at once. This can prevent tearing or flickering
+	when the terminal updates faster than Nvim can redraw.
+
 						*'textwidth'* *'tw'*
 'textwidth' 'tw'	number	(default 0)
 			local to buffer
-- 
cgit 


From c4afb9788c4f139eb2e3b7aa4d6a6a20b67ba156 Mon Sep 17 00:00:00 2001
From: Luuk van Baal 
Date: Sat, 11 Nov 2023 00:52:50 +0100
Subject: refactor(sign): move legacy signs to extmarks

Problem:  The legacy signlist data structures and associated functions are
          redundant since the introduction of extmark signs.
Solution: Store signs defined through the legacy commands in a hashmap, placed
          signs in the extmark tree. Replace signlist associated functions.

Usage of the legacy sign commands should yield no change in behavior with the
exception of:
  - "orphaned signs" are now always removed when the line it is placed on is
    deleted. This used to depend on the value of 'signcolumn'.
  - It is no longer possible to place multiple signs with the same identifier
    in a single group on multiple lines. This will now move the sign instead.

Moreover, both signs placed through the legacy sign commands and through
|nvim_buf_set_extmark()|:
  - Will show up in both |sign-place| and |nvim_buf_get_extmarks()|.
  - Are displayed by increasing sign identifier, left to right.
    Extmark signs used to be ordered decreasingly as opposed to legacy signs.
---
 runtime/doc/options.txt | 6 ------
 1 file changed, 6 deletions(-)

(limited to 'runtime/doc/options.txt')

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 07326c8c13..f47093782c 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -5624,12 +5624,6 @@ A jump table for the options with a short description can be found at |Q_op|.
 	   "number"	display signs in the 'number' column. If the number
 			column is not present, then behaves like "auto".
 
-	Note regarding "orphaned signs": with signcolumn numbers higher than
-	1, deleting lines will also remove the associated signs automatically,
-	in contrast to the default Vim behavior of keeping and grouping them.
-	This is done in order for the signcolumn appearance not appear weird
-	during line deletion.
-
 			*'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
 'smartcase' 'scs'	boolean	(default off)
 			global
-- 
cgit