diff options
author | Bram Moolenaar <Bram@vim.org> | 2022-04-08 17:45:08 +0100 |
---|---|---|
committer | Bram Moolenaar <Bram@vim.org> | 2022-04-08 17:45:08 +0100 |
commit | cbaff5e06ec525d31dc44093125c42029e01d508 (patch) | |
tree | cf90237ea61147e5cf690a9db7f36741fd3aa0a5 /runtime/doc/options.txt | |
parent | a8034a4886843fbf10bd59a6f55ec723da515b8e (diff) |
Update runtime files
Diffstat (limited to 'runtime/doc/options.txt')
-rw-r--r-- | runtime/doc/options.txt | 122 |
1 files changed, 62 insertions, 60 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 8b2021107b..443175a856 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1,4 +1,4 @@ -*options.txt* For Vim version 8.2. Last change: 2022 Mar 29 +*options.txt* For Vim version 8.2. Last change: 2022 Apr 07 VIM REFERENCE MANUAL by Bram Moolenaar @@ -87,7 +87,7 @@ achieve special effects. These options come in three forms: :se[t] {option}+={value} *:set+=* Add the {value} to a number option, or append the {value} to a string option. When the option is a - comma separated list, a comma is added, unless the + comma-separated list, a comma is added, unless the value was empty. If the option is a list of flags, superfluous flags are removed. When adding a flag that was already @@ -97,7 +97,7 @@ achieve special effects. These options come in three forms: :se[t] {option}^={value} *:set^=* Multiply the {value} to a number option, or prepend the {value} to a string option. When the option is a - comma separated list, a comma is added, unless the + comma-separated list, a comma is added, unless the value was empty. Also see |:set-args| above. @@ -1019,7 +1019,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "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. + done. This is a comma-separated list of words. The main values are: "yes" make a copy of the file and overwrite the original one @@ -1043,10 +1043,10 @@ A jump table for the options with a short description can be found at |Q_op|. file. - When the file is a link the new file will not be a link. - The "auto" value is the middle way: When Vim sees that renaming file - is possible without side effects (the attributes can be passed on and - the file is not a link) that is used. When problems are expected, a - copy will be made. + The "auto" value is the middle way: When Vim sees that renaming the + file is possible without side effects (the attributes can be passed on + and the file is not a link) that is used. When problems are expected, + a copy will be made. The "breaksymlink" and "breakhardlink" values can be used in combination with any of "yes", "no" and "auto". When included, they @@ -1065,13 +1065,13 @@ A jump table for the options with a short description can be found at |Q_op|. When a copy is made, the original file is truncated and then filled with the new text. This means that protection bits, owner and - symbolic links of the original file are unmodified. The backup file + symbolic links of the original file are unmodified. The backup file, however, is a new file, owned by the user who edited the file. The group of the backup is set to the group of the original file. If this fails, the protection bits for the group are made the same as for others. - When the file is renamed this is the other way around: The backup has + When the file is renamed, this is the other way around: The backup has the same attributes of the original file, and the newly written file is owned by the current user. When the file was a (hard/symbolic) link, the new file will not! That's why the "auto" value doesn't @@ -1138,7 +1138,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 @@ -1402,7 +1402,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'browsedir'* *'bsdir'* 'browsedir' 'bsdir' string (default: "last") global - {only for Motif, Athena, GTK, Mac and Win32 GUI} + {only for Motif, GTK, Mac and Win32 GUI} Which directory to use for the file browser: last Use same directory as with last file browser, where a file was opened or saved. @@ -1416,16 +1416,16 @@ A jump table for the options with a short description can be found at |Q_op|. This option specifies what happens when a buffer is no longer displayed in a window: <empty> follow the global 'hidden' option - hide hide the buffer (don't unload it), also when 'hidden' - is not set - unload unload the buffer, also when 'hidden' is set or using - |:hide| - delete delete the buffer from the buffer list, also when - 'hidden' is set or using |:hide|, like using - |:bdelete| - wipe wipe out the buffer from the buffer list, also when - 'hidden' is set or using |:hide|, like using - |:bwipeout| + hide hide the buffer (don't unload it), even if 'hidden' is + not set + unload unload the buffer, even if 'hidden' is set; the + |:hide| command will also unlod the buffer + delete delete the buffer from the buffer list, even if + 'hidden' is set; the |:hide| command will also delete + the buffer, making it behave like |:bdelete| + wipe wipe the buffer from the buffer list, even if + 'hidden' is set; the |:hide| command will also wipe + out the buffer, making it behave like |:bwipeout| CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer are lost without a warning. Also, these values may break autocommands @@ -1778,7 +1778,7 @@ A jump table for the options with a short description can be found at |Q_op|. local to window {not available when compiled without the |+syntax| feature} - 'colorcolumn' is a comma separated list of screen columns that are + 'colorcolumn' is a comma-separated list of screen columns that are highlighted with ColorColumn |hl-ColorColumn|. Useful to align text. Will make screen redrawing slower. The screen column can be an absolute number, or a number preceded with @@ -1812,7 +1812,7 @@ A jump table for the options with a short description can be found at |Q_op|. '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 + A comma-separated list of strings that can start a comment line. See |format-comments|. See |option-backslash| about using backslashes to insert a space. @@ -1953,7 +1953,7 @@ A jump table for the options with a short description can be found at |Q_op|. This option specifies how keyword completion |ins-completion| works when CTRL-P or CTRL-N are used. It is also used for whole-line completion |i_CTRL-X_CTRL-L|. It indicates the type of completion - and the places to scan. It is a comma separated list of flags: + and the places to scan. It is a comma-separated list of flags: . scan the current buffer ('wrapscan' is ignored) w scan buffers from other windows b scan other loaded buffers that are in the buffer list @@ -2022,7 +2022,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'completeopt'* *'cot'* 'completeopt' 'cot' string (default: "menu,preview") global - A comma separated list of options for Insert mode completion + A comma-separated list of options for Insert mode completion |ins-completion|. The supported values are: menu Use a popup menu to show the possible completions. The @@ -2638,7 +2638,7 @@ A jump table for the options with a short description can be found at |Q_op|. local to window {not available when compiled without the |+syntax| feature} - Comma separated list of settings for how 'cursorline' is displayed. + Comma-separated list of settings for how 'cursorline' is displayed. Valid values: "line" Highlight the text line of the cursor with CursorLine |hl-CursorLine|. @@ -2918,7 +2918,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'display' 'dy' string (default "", set to "truncate" in |defaults.vim|) global - Change the way text is displayed. This is comma separated list of + Change the way text is displayed. This is comma-separated list of flags: lastline When included, as much as possible of the last line in a window will be displayed. "@@@" is put in the @@ -3122,7 +3122,7 @@ A jump table for the options with a short description can be found at |Q_op|. A list of autocommand event names, which are to be ignored. When set to "all" or when "all" is one of the items, all autocommand events are ignored, autocommands will not be executed. - Otherwise this is a comma separated list of event names. Example: > + Otherwise this is a comma-separated list of event names. Example: > :set ei=WinEnter,WinLeave < *'expandtab'* *'et'* *'noexpandtab'* *'noet'* @@ -3382,7 +3382,7 @@ A jump table for the options with a short description can be found at |Q_op|. {not available when compiled without the |+folding| feature} Characters to fill the statuslines and vertical separators. - It is a comma separated list of items: + It is a comma-separated list of items: item default Used for ~ stl:c ' ' or '^' statusline of the current window @@ -3572,7 +3572,7 @@ A jump table for the options with a short description can be found at |Q_op|. {not available when compiled without the |+folding| feature} 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 + command moves the cursor into a closed fold. It is a comma-separated list of items. NOTE: When the command is part of a mapping this option is not used. Add the |zv| command to the mapping to get the same effect. @@ -3790,7 +3790,7 @@ A jump table for the options with a short description can be found at |Q_op|. For a console the 't_SI', 't_SR', and 't_EI' escape sequences are used. - The option is a comma separated list of parts. Each part consist of a + The option is a comma-separated list of parts. Each part consist of a mode-list and an argument-list: mode-list:argument-list,mode-list:argument-list,.. The mode-list is a dash separated list of these modes: @@ -3909,7 +3909,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'guioptions'* *'go'* 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is removed in |defaults.vim|), - "aegimrLtT" (GTK, Motif and Athena), + "aegimrLtT" (GTK and Motif), ) global {only available when compiled with GUI enabled} @@ -3990,13 +3990,12 @@ A jump table for the options with a short description can be found at |Q_op|. *'go-g'* 'g' Grey menu items: Make menu items that are not active grey. If 'g' is not included inactive menu items are not shown at all. - Exception: Athena will always use grey menu items. *'go-t'* 't' Include tearoff menu items. Currently only works for Win32, GTK+, and Motif 1.2 GUI. *'go-T'* - 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon - and Athena GUIs. + 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and + Photon GUIs. *'go-r'* 'r' Right-hand scrollbar is always present. *'go-R'* @@ -4102,7 +4101,7 @@ A jump table for the options with a short description can be found at |Q_op|. global {only available when compiled with the |+multi_lang| feature} - Comma separated list of languages. Vim will use the first language + Comma-separated list of languages. Vim will use the first language for which the desired help can be found. The English help will always be used as a last resort. You can add "en" to prefer English over another language, but that will only find tags that exist in that @@ -4121,10 +4120,14 @@ A jump table for the options with a short description can be found at |Q_op|. When off a buffer is unloaded when it is |abandon|ed. When on a buffer becomes hidden when it is |abandon|ed. If the buffer is still displayed in another window, it does not become hidden, of course. + The commands that move through the buffer list sometimes make a buffer - hidden although the 'hidden' option is off: When the buffer is - modified, 'autowrite' is off or writing is not possible, and the '!' - flag was used. See also |windows.txt|. + hidden even if the 'hidden' option is off when these three are true: + - the buffer is modified + - 'autowrite' is off or writing is not possible + - the '!' flag was used + Also see |windows.txt|. + To only make one buffer hidden use the 'bufhidden' option. This option is set for one command with ":hide {command}" |:hide|. WARNING: It's easy to forget that you have changes in hidden buffers. @@ -4150,7 +4153,7 @@ A jump table for the options with a short description can be found at |Q_op|. z:StatusLineTerm,Z:StatusLineTermNC") global This option can be used to set highlighting mode for various - occasions. It is a comma separated list of character pairs. The + occasions. It is a comma-separated list of character pairs. The first character in a pair gives the occasion, the second the mode to use for that occasion. The occasions are: |hl-SpecialKey| 8 Meta and special keys listed with ":map" @@ -4405,7 +4408,7 @@ A jump table for the options with a short description can be found at |Q_op|. |i_CTRL-^|. The value is set to 1 when setting 'keymap' to a valid keymap name. It is also used for the argument of commands like "r" and "f". - The value 0 may not work correctly with Athena and Motif with some XIM + The value 0 may not work correctly with Motif with some XIM methods. Use 'imdisable' to disable XIM then. You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM @@ -4426,7 +4429,7 @@ A jump table for the options with a short description can be found at |Q_op|. |c_CTRL-^|. The value is set to 1 when it is not -1 and setting the 'keymap' option to a valid keymap name. - The value 0 may not work correctly with Athena and Motif with some XIM + The value 0 may not work correctly with Motif with some XIM methods. Use 'imdisable' to disable XIM then. *'imstatusfunc'* *'imsf'* @@ -4817,7 +4820,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'keymodel'* *'km'* 'keymodel' 'km' string (default "") global - List of comma separated words, which enable special things that keys + List of comma-separated words, which enable special things that keys can do. These values can be used: startsel Using a shifted special key starts selection (either Select mode or Visual mode, depending on "key" being @@ -5018,7 +5021,7 @@ A jump table for the options with a short description can be found at |Q_op|. global or local to buffer |global-local| {not available when compiled without the |+lispindent| feature} - Comma separated list of words that influence the Lisp indenting. + Comma-separated list of words that influence the Lisp indenting. |'lisp'| *'list'* *'nolist'* @@ -5042,7 +5045,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'listchars' 'lcs' string (default "eol:$") 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. + comma-separated list of string settings. *lcs-eol* eol:c Character to show at the end of each line. When omitted, there is no extra character at the end of the @@ -5547,7 +5550,7 @@ A jump table for the options with a short description can be found at |Q_op|. {only available when compiled with the |+mouseshape| feature} This option tells Vim what the mouse pointer should look like in - different modes. The option is a comma separated list of parts, much + different modes. The option is a comma-separated list of parts, much like used for 'guicursor'. Each part consist of a mode/location-list and an argument-list: mode-list:shape,mode-list:shape,.. @@ -6688,7 +6691,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'selectmode'* *'slm'* 'selectmode' 'slm' string (default "") global - This is a comma separated list of words, which specifies when to start + This is a comma-separated list of words, which specifies when to start Select mode instead of Visual mode, when a selection is started. Possible values: mouse when using the mouse @@ -7307,7 +7310,7 @@ A jump table for the options with a short description can be found at |Q_op|. commands. It must end in ".{encoding}.add". You need to include the path, otherwise the file is placed in the current directory. *E765* - It may also be a comma separated list of names. A count before the + 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 a personal word list file and a project word list file. When a word is added while this option is empty Vim will set it for @@ -7329,7 +7332,7 @@ A jump table for the options with a short description can be found at |Q_op|. local to buffer {not available when compiled without the |+syntax| feature} - A comma separated list of word list names. When the 'spell' option is + A comma-separated list of word list names. When the 'spell' option is on spellchecking will be done for these languages. Example: > set spelllang=en_us,nl,medical < This means US English, Dutch and medical words are recognized. Words @@ -7374,7 +7377,7 @@ A jump table for the options with a short description can be found at |Q_op|. local to buffer {not available when compiled without the |+syntax| feature} - A comma separated list of options for spell checking: + A comma-separated list of options for spell checking: camel When a word is CamelCased, assume "Cased" is a separate word: every upper-case character in a word that comes after a lower case character indicates the @@ -7679,7 +7682,7 @@ A jump table for the options with a short description can be found at |Q_op|. local to buffer {not available when compiled without the |+file_in_path| feature} - Comma separated list of suffixes, which are used when searching for a + Comma-separated list of suffixes, which are used when searching for a file for the "gf", "[I", etc. commands. Example: > :set suffixesadd=.java < @@ -7725,7 +7728,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. Mostly for |quickfix| commands some values are also used for other commands, as mentioned below. - Possible values (comma separated list): + 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. @@ -8358,8 +8361,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'toolbar'* *'tb'* 'toolbar' 'tb' string (default "icons,tooltips") global - {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and - |+GUI_Photon|} + {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|} The contents of this option controls various toolbar settings. The possible values are: icons Toolbar buttons are shown with icons. @@ -8373,7 +8375,7 @@ A jump table for the options with a short description can be found at |Q_op|. If you want the toolbar to be shown with icons as well as text, do the following: > :set tb=icons,text -< Motif and Athena cannot display icons and text at the same time. They +< Motif cannot display icons and text at the same time. They will show icons if both are requested. If none of the strings specified in 'toolbar' are valid or if @@ -8692,7 +8694,7 @@ A jump table for the options with a short description can be found at |Q_op|. global {not available when compiled without the |+mksession| feature} - Changes the effect of the |:mkview| command. It is a comma separated + Changes the effect of the |:mkview| command. It is a comma-separated list of words. Each word enables saving and restoring something: word save and restore ~ cursor cursor position in file and in window @@ -8722,7 +8724,7 @@ A jump table for the options with a short description can be found at |Q_op|. When non-empty, the viminfo file is read upon startup and written when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is "NONE". - The string should be a comma separated list of parameters, each + The string should be a comma-separated list of parameters, each consisting of a single character identifying the particular parameter, followed by a number or string which specifies the value of that parameter. If a particular character is left out, then the default @@ -8845,7 +8847,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'virtualedit'* *'ve'* 'virtualedit' 've' string (default "") global or local to window |global-local| - A comma separated list of these words: + A comma-separated list of these words: block Allow virtual editing in Visual block mode. insert Allow virtual editing in Insert mode. all Allow virtual editing in all modes. @@ -9061,7 +9063,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'wildmode' 'wim' string (Vim 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 + 'wildchar'. It is a comma-separated list of up to four parts. Each part specifies what to do for each consecutive use of 'wildchar'. The first part specifies the behavior for the first use of 'wildchar', The second part for the second use, etc. |