Lines Matching refs:option
9 1. Setting options |set-option|
11 3. Options summary |option-summary|
13 For an overview of options see quickref.txt |option-list|.
22 1. Setting options *set-option* *E764*
26 When [!] is present every option is on a separate
30 When [!] is present every option is on a separate
39 :se[t] {option}? Show value of {option}.
41 :se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
45 :se[t] no{option} Toggle option: Reset, switch it off.
48 :se[t] {option}! or
49 :se[t] inv{option} Toggle option: Invert value.
52 :se[t] {option}& Reset option to its default value. May depend on the
54 :se[t] {option}&vi Reset option to its Vi default value.
55 :se[t] {option}&vim Reset option to its Vim default value.
71 :se[t] {option}={value} or
72 :se[t] {option}:{value}
73 Set string or number option to {value}.
79 White space between {option} and '=' is allowed and
82 See |option-backslash| for using white space and
85 :se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
90 If the option is a list of flags, superfluous flags
92 present the option value doesn't change.
95 :se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
102 :se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
114 The {option} arguments to ":set" may be repeated. For example: >
120 When 'verbose' is non-zero, displaying an option value will also tell where it
127 This is only done when specific option values are requested, not for ":verbose
129 When the option was set by hand there is no "Last set" message.
130 When the option was set while executing a function, user command or
132 Note that an option may also have been set as a side effect of setting
151 For {option} the form "t_xx" may be used to set a terminal option. This will
181 *option-backslash*
182 To include white space in a string option value it has to be preceded with a
184 means that the number of backslashes in an option value is halved (rounded
192 include the "|" in the option value, use "\|" instead. This example sets the
193 'titlestring' option to "hi|there": >
195 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
199 include the '"' in the option value, use '\"' instead. This example sets the
200 'titlestring' option to 'hi "there"': >
224 *add-option-flags* *remove-option-flags*
227 option, without changing the existing ones, you can do it like this: >
229 Remove a flag from an option like this: >
245 When adding or removing a string from an option with ":set opt-=val" or ":set
252 has its own copy of this option, thus each can have its own value. This
258 the option values you would expect. Unfortunately, doing what the user
264 When editing a new buffer, its local option values must be initialized. Since
266 these are not used. Instead, for each buffer-local option there also is a
276 It's possible to set a local window option specifically for a type of buffer.
285 Now the 'list' option will also be set in "two", since with the ":set list"
291 Now the 'list' option is not set, because ":set nolist" resets the global
303 local value. If the option does not have a local
309 When displaying a specific local option, show the
310 local value. For a global/local boolean option, when
312 before the option name.
313 For a global option the global value is
316 :setl[ocal] {option}< Set the local value of {option} to its global value by
319 :se[t] {option}< For |global-local| options: Remove the local value of
320 {option}, so that the global value will be used.
324 option without changing the local value.
325 When displaying an option, the global value is shown.
333 :set option=value set set
334 :setlocal option=value - set
335 :setglobal option=value set -
336 :set option? - display
337 :setlocal option? - display
338 :setglobal option? display -
350 'makeprg' option. If you do this in one of the two windows: >
353 the 'makeprg' option in the other C source window too.
360 This only works for a string option. For a number or boolean option you need
371 ":setlocal" on a global option might work differently then.
374 *option-value-function*
388 Set the 'filetype' option to {filetype}, but only if
395 setting the 'filetype' option twice, causing different
404 *option-window* *optwin*
408 Offers short help for each option. Hit <CR> on the
410 the option.
411 Modify the value of the option and hit <CR> on the
414 used to set the option value in, unless this is a help
416 used (skipping the option-window).
422 option and after a space or comma.
433 command, not when assigning a value to an option with ":let".
450 Note the maximum length of an expanded option is limited. How much depends on
515 3. If you start editing a new file, and the 'modeline' option is on, a
528 {options} a list of option settings, separated with white space
575 the files in it set the same global option to a different value, the result
580 option after opening the file, it won't be changed if you edit the same buffer
598 The number of lines that are checked can be set with the 'modelines' option.
612 This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
626 Hint: If you would like to do something else than setting an option, you could
634 3. Options summary *option-summary*
639 In this document when a boolean option is "set" that means that ":set option"
640 is entered. When an option is "reset", ":set nooption" is used.
648 different value in each window. For example the 'list' option can be set in
652 the 'textwidth' option can be 78 for a normal text file and 0 for a C
655 global one option for all buffers and windows
656 local to window each window has its own copy of this option
657 local to buffer each buffer has its own copy of this option
659 When creating a new window the option values from the currently active window
662 'cpoptions' option. If 's' is included (which is the default) the values for
673 below. When an option is not supported it may still be set without getting an
674 error, this is called a hidden option. You can't get the value of a hidden
675 option though, it is not stored.
677 To test if option "foo" can be used with ":set" use something like this: >
679 This also returns true for a hidden option. To test if option "foo" is really
707 NOTE: This option is reset when 'compatible' is set.
714 This option was for using Farsi, which has been removed. See
745 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
746 this option should be set to "double" to match the width perceived
752 Vim may set this option automatically at startup time when Vim is
762 This option only has an effect in the GUI version of Vim on macOS
765 Setting this option can sometimes cause problems if 'guifont' is set
767 NOTE: This option is reset when 'compatible' is set.
778 Note: When this option is on some plugins may not work.
794 This option can be set to start editing Arabic text.
795 Setting this option will:
796 - Set the 'rightleft' option, unless 'termbidi' is set.
797 - Set the 'arabicshape' option, unless 'termbidi' is set.
798 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
800 - Set the 'delcombine' option
803 Resetting this option will:
804 - Reset the 'rightleft' option.
807 option).
808 NOTE: This option is reset when 'compatible' is set.
829 NOTE: This option is set when 'compatible' is set.
845 The 'autoindent' option is reset when the 'paste' option is set and
856 If this option has a local value, use this command to switch back to
867 Note that for some commands the 'autowrite' option is not used, see
877 Setting this option also implies that Vim behaves like 'autowrite' has
888 Setting this option does not change the background color, it tells Vim
908 When the |t_RB| option is set, Vim will use it to request the background
933 Normally this option would be set in the .vimrc file. Possibly
938 < When this option is set, the default settings for the highlight groups
940 the setting of the 'background' option.
941 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
943 option, you must load syntax.vim again to see the result. This can be
971 NOTE: This option is set to "" when 'compatible' is set.
979 written, reset this option and set the 'writebackup' option (this is
986 NOTE: This option is reset when 'compatible' is set.
991 When writing a file and a backup is made, this option tells how it's
1024 exactly what the "no" option does, renaming the original file to
1053 NOTE: This option is set to the Vi default value when 'compatible' is
1088 get one in the option (see |option-backslash|), for example: >
1091 of the option is removed.
1100 This option cannot be set from a |modeline| or in the |sandbox|, for
1130 Watch out for special characters, see |option-backslash|.
1211 modeline, see |sandbox-option|.
1212 This option cannot be set in a modeline when 'modelineexpr' is off.
1222 NOTE: This option is set to "" when 'compatible' is set.
1267 This option should be set before editing a binary file. You can also
1268 use the |-b| Vim argument. When this option is switched on a few
1279 NOTE: When you start editing a(nother) file while the 'bin' option is
1285 saved option values.
1292 the 'endofline' option.
1305 - this option is on
1306 - the 'binary' option is off
1324 This option lets you choose which characters might cause a line
1336 NOTE: This option is reset when 'compatible' is set.
1378 This option specifies what happens when a buffer is no longer
1380 <empty> follow the global 'hidden' option
1395 This option is used together with 'buftype' and 'swapfile' to specify
1401 When this option is set, the buffer shows up in the buffer list. If
1403 This option is reset by Vim for buffers that are only used to remember
1410 The value of this option specifies the type of a buffer:
1429 This option is used together with 'bufhidden' and 'swapfile' to
1433 Be careful with changing this option, it can have many side effects!
1486 "/", "./" or "../", the 'cdpath' option is not used then.
1487 The 'cdpath' option's value has the same form and semantics as
1495 < This option cannot be set from a |modeline| or in the |sandbox|, for
1509 < |Nvi| also has this option, but it only uses the first character.
1511 NOTE: This option is set to the Vim default value when 'compatible'
1554 This option cannot be set from a |modeline| or in the |sandbox|, for
1571 option or 'indentexpr'.
1572 This option is not used when 'paste' is set.
1573 NOTE: This option is reset when 'compatible' is set.
1583 For the format of this option see |cinkeys-format|.
1592 program. See |cinoptions-values| for the values of this option, and
1614 This option is a list of comma separated names.
1637 option, yank operations (but not delete, change or
1694 The rest of the option value will be used for
1702 The value of this option is stored with the tab page, so that each tab
1735 option will cause the window size to be changed. When you only want
1737 When you set this option and Vim is unable to change the physical
1750 |format-comments|. See |option-backslash| about using backslashes to
1766 This option has the effect of making Vim either more Vi-compatible, or
1769 This is a special kind of option, because when it's set or reset,
1771 NOTE: Setting or resetting this option can have a lot of unexpected
1773 differently, etc. If you set this option in your vimrc file, you
1776 By default this option is on and the Vi defaults are used for the
1779 option.
1781 this option is switched off, and all options that have not been
1788 You can also set this option with the "-C" argument, and reset it with
1792 When this option is set, numerous other options are set to make Vim as
1793 Vi-compatible as possible. When this option is unset, various options
1797 + Means that the option is set to the value given in {set value} when
1799 & Means that the option is set to the value given in {set value} when
1802 - Means the option is NOT changed when setting 'compatible' but IS
1806 option ? set value effect ~
1886 This option specifies how keyword completion |ins-completion| works
1895 k scan the files given with the 'dictionary' option
1900 < s scan the files given with the 'thesaurus' option
1931 This option specifies a function to be used for Insert mode completion
1935 This option cannot be set from a |modeline| or in the |sandbox|, for
1942 When this option is set it overrules 'shellslash' for completion:
1943 - When this option is set to "slash", a forward slash is used for path
1946 - When this option is set to "backslash", backslash is used. This is
1948 - When this option is empty, same character is used as for
1970 of completion. For buffer text the 'ignorecase' option is
2004 When 'completeopt' contains "popup" then this option is used for the
2006 window already exists it is closed, so that the option value is
2057 option.
2082 in which case only spaces are used). Enabling this option makes the
2087 NOTE: This option is reset when 'compatible' is set.
2100 "+=" and "-=" feature of ":set" |add-option-flags|.
2101 NOTE: This option is set to the Vi default value when 'compatible' is
2103 NOTE: This option is set to the POSIX default value at startup when
2145 d Using "./" in the 'tags' option doesn't mean to use
2214 L When the 'list' option is set, 'wrapmargin',
2266 buffer. When you change an option and go to another
2308 Z When using "w!" while the 'readonly' option is set,
2465 NOTE: This option is set to 0 when 'compatible' is set.
2473 This option cannot be set from a |modeline| or in the |sandbox|, for
2489 In the absence of a prefix (-P) for cscope. setting this option enables
2492 NOTE: This option is reset when 'compatible' is set.
2500 NOTE: This option is reset when 'compatible' is set.
2509 NOTE: This option is set to 0 when 'compatible' is set.
2518 NOTE: This option is reset when 'compatible' is set.
2523 When this option is set, as the cursor in the current
2525 this option set) move their cursors to the corresponding line and
2526 column. This option is useful for viewing the
2595 pattern, just like for the "/" command. This option is used for the
2596 commands like "[i" and "[d" |include-search|. The 'isident' option is
2599 See |option-backslash| about inserting backslashes to include a space
2618 If editing Unicode and this option is set, backspace and Normal mode
2627 NOTE: This option is reset when 'compatible' is set.
2638 When this option is empty or an entry "spell" is present, and spell
2644 name. See |option-backslash| about using backslashes.
2653 Backticks cannot be used in this option for security reasons.
2670 This option cannot be set from a |modeline| or in the |sandbox|, for
2742 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2745 followwrap Follow the 'wrap' option and leave as it is.
2752 option to see when this happens.
2780 NOTE: This option is reset when 'compatible' is set.
2820 get one in the option (see |option-backslash|), for example: >
2823 of the option is removed.
2835 This option cannot be set from a |modeline| or in the |sandbox|, for
2859 Tells when the 'equalalways' option applies:
2869 also 'gdefault' option.
2870 Switching this option on may break plugins!
2871 This option is not used in |Vim9| script.
2891 NOTE: Changing this option will not change the encoding of the
2896 This option cannot be set from a |modeline|. It would most likely
2920 When you set this option, it fires the |EncodingChanged| autocommand
2923 When the option is set, the value is converted to lowercase. Thus
2948 When writing a file and this option is off and the 'binary' option
2949 is on, or 'fixeol' option is off, no <EOL> will be written for the
2950 last line in the file. This option is automatically set or reset when
2953 reset this option.
2965 option is switched on. When off, splitting a window will reduce the
2971 'eadirection' option tells in which direction the size is affected.
2981 External program to use for "=" command. When this option is empty
2985 Environment variables are expanded |:set_env|. See |option-backslash|
2987 This option cannot be set from a |modeline| or in the |sandbox|, for
3011 See |option-backslash| about including spaces and backslashes.
3012 This option cannot be set from a |modeline| or in the |sandbox|, for
3027 mode. When this option is off, the cursor and function keys cannot be
3030 after one second. Instead of resetting this option, you might want to
3034 NOTE: This option is set to the Vi default value when 'compatible' is
3036 NOTE: when this option is off then the |modifyOtherKeys| functionality
3056 This option is reset when the 'paste' option is set and restored when
3057 the 'paste' option is reset.
3058 NOTE: This option is reset when 'compatible' is set.
3066 Setting this option is a potential security leak. E.g., consider
3072 If you do switch this option on you should also consider setting the
3073 'secure' option (see |initialization|).
3075 This option cannot be set from a |modeline| or in the |sandbox|, for
3109 When the option is set, the value is converted to lowercase. Thus
3115 When this option is set, after starting to edit a file, the 'modified'
3116 option is set, because the file would be different when written.
3123 This option can not be changed when 'modifiable' is off.
3126 NOTE: Before version 6.0 this option specified the encoding for the
3185 Setting this option does not have an effect until the next time a file
3202 This option is set automatically when starting to edit a file and
3204 When this option is set, after starting to edit a file, the 'modified'
3205 option is set, because the file would be different when written.
3206 This option can not be changed when 'modifiable' is off.
3207 For backwards compatibility: When this option is set to "dos",
3246 file only, the option is not changed.
3262 For backwards compatibility: When this option is set to an empty
3265 NOTE: This option is set to the Vi default value when 'compatible' is
3278 When this option is set, the FileType autocommand event is triggered.
3279 All autocommands that match with the value of this option will be
3282 Otherwise this option does not always reflect the current file type.
3283 This option is normally set when the file type is detected. To enable
3285 Setting this option to a different value is most useful in a modeline,
3296 This option is not copied to another buffer, independent of the 's' or
3316 diff:c '-' deleted lines of the 'diff' option
3343 When writing a file and this option is on, <EOL> at the end of file
3344 will be restored if missing. Turn this option off if you want to
3346 When the 'binary' option is set the value of this option doesn't
3348 See the 'endofline' option.
3355 This option was for using Farsi, which has been removed. See
3382 When off, all folds are open. This option can be used to quickly
3387 This option is set by commands that create a new fold or close a fold.
3399 modeline, see |sandbox-option|.
3400 This option can't be set from a |modeline| when the 'diff' option is
3401 on or the 'modelineexpr' option is off.
3422 Setting this option to zero will close all folds. Higher numbers will
3424 This option is set by commands like |zm|, |zM| and |zR|.
3436 overrules this option. Starting to edit a file for |diff-mode| also
3437 ignores this option and closes all folds.
3496 NOTE: When the command is part of a mapping this option is not used.
3515 this option is not used. This means the operator will include the
3522 set the 'foldclose' option to "all".
3533 modeline, see |sandbox-option|.
3534 This option cannot be set in a modeline when 'modelineexpr' is off.
3546 option is empty 'formatprg' is used.
3570 modeline, see |sandbox-option|. That stops the option from working,
3572 This option cannot be set in a modeline when 'modelineexpr' is off.
3573 NOTE: This option is set to "" when 'compatible' is set.
3592 formatting is to be done. See |fo-table|. When the 'paste' option is
3596 "+=" and "-=" feature of ":set" |add-option-flags|.
3597 NOTE: This option is set to the Vi default value when 'compatible' is
3607 If the 'formatexpr' option is not empty it will be used instead.
3608 Otherwise, if 'formatprg' option is an empty string, the internal
3610 Environment variables are expanded |:set_env|. See |option-backslash|
3612 This option cannot be set from a |modeline| or in the |sandbox|, for
3629 This option cannot be set from a |modeline| or in the |sandbox|, for
3645 NOTE: This option is reset when 'compatible' is set.
3646 DEPRECATED: Setting this option may break plugins that are not aware
3647 of this option. Also, many users get confused that adding the /g flag
3649 This option is not used in |Vim9| script.
3656 'errorformat' option: see |errorformat|.
3664 Program to use for the |:grep| command. This option may contain '%'
3668 |option-backslash| about including spaces and backslashes.
3679 This option cannot be set from a |modeline| or in the |sandbox|, for
3696 This option tells Vim what the cursor should look like in different
3703 The option is a comma separated list of parts. Each part consist of a
3816 < Changing this option updates screen output immediately. Set it to an
3826 This option only has an effect in the GUI version of Vim. It is a
3830 "+=" and "-=" feature of ":set" |add-option-flags|.
3886 Note: Set this option in the vimrc file. The forking may have
3966 The format of this option is like that of 'statusline'.
3969 modeline, see |sandbox-option|.
3970 This option cannot be set in a modeline when 'modelineexpr' is off.
3982 This option is otherwise just like 'guitablabel' above.
3996 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
3998 This option cannot be set from a |modeline| or in the |sandbox|, for
4006 current window, or (when the 'ea' option is on) the same as other
4025 try to find the tag in the current language before using this option.
4035 hidden although the 'hidden' option is off: When the buffer is
4038 To only make one buffer hidden use the 'bufhidden' option.
4039 This option is set for one command with ":hide {command}" |:hide|.
4062 This option can be used to set highlighting mode for various
4079 when 'number' or 'relativenumber' option is set.
4081 'relativenumber' option is set.
4083 'relativenumber' option is set.
4140 is remembered. This option decides how many entries may be stored in
4143 NOTE: This option is set to the Vi default value when 'compatible' is
4153 toggle this option. See |rileft.txt|.
4154 NOTE: This option is reset when 'compatible' is set.
4164 NOTE: This option is reset when 'compatible' is set.
4173 'highlight' option. This uses the "Search" highlight group by
4178 off with |:nohlsearch|. This does not change the option value, as
4188 NOTE: This option is reset when 'compatible' is set.
4198 Overridden by the 'iconstring' option.
4200 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4213 When this option is not empty, it will be used for the icon text of
4214 the window. This happens only when the 'icon' option is on.
4216 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4220 When this option contains printf-style '%' items, they will be
4223 This option cannot be set in a modeline when 'modelineexpr' is off.
4238 This option specifies a function that will be called to
4242 modeline, see |sandbox-option|.
4263 You can't use this option to change the activation key, the option
4291 Setting this option is useful when your input method allows entering
4300 Currently this option is on by default for SGI/IRIX machines. This
4311 To always reset the option to zero when leaving Insert mode with <Esc>
4316 Note that this option changes when using CTRL-^ in Insert mode
4337 Note that this option changes when using CTRL-^ in Command-line mode
4340 option to a valid keymap name.
4347 This option specifies a function that is called to obtain the status
4360 modeline, see |sandbox-option|.
4367 This option specifies the input style of Input Method:
4378 modeline, see |sandbox-option|.
4387 value is for C programs. This option is used for the commands "[i",
4389 Normally the 'isfname' option is used to recognize the file name that
4395 See |option-backslash| about including spaces and backslashes.
4403 option to a file name. Mostly useful to change "." to "/" for Java: >
4412 modeline, see |sandbox-option|.
4413 This option cannot be set in a modeline when 'modelineexpr' is off.
4467 NOTE: This option is reset when 'compatible' is set.
4476 in Insert mode as specified with the 'indentkeys' option.
4477 When this option is not empty, it overrules the 'cindent' and
4478 'smartindent' indenting. When 'lisp' is set, this option is
4480 When 'paste' is set this option is not used for indenting.
4492 Normally this option would be set to call a function: >
4494 < Error messages will be suppressed, unless the 'debug' option contains
4497 NOTE: This option is set to "" when 'compatible' is set.
4500 modeline, see |sandbox-option|.
4501 This option cannot be set in a modeline when 'modelineexpr' is off.
4554 NOTE: This option is reset when 'compatible' is set.
4564 The characters specified by this option are included in file names and
4568 characters up to 255 are specified with this option.
4570 Think twice before adding white space to this option. Although a
4583 The format of this option is a list of parts, separated with commas.
4591 will be excluded from the option. The option is interpreted from left
4594 option or the end of a range. Example:
4608 See |option-backslash| about including spaces and backslashes.
4615 The characters given by this option are included in identifiers.
4617 match of the 'define' option. It is also used for "\i" in a
4619 option. For '@' only characters up to 255 are used.
4620 Careful: If you change this option, it might break expanding
4632 'isfname' for a description of the format of this option. For '@'
4639 When the 'lisp' option is on the '-' character is always included.
4640 This option also influences syntax highlighting, unless the syntax
4642 NOTE: This option is set to the Vi default value when 'compatible' is
4649 The characters given by this option are displayed directly on the
4653 'isfname' for a description of the format of this option.
4670 characters up to 255 are specified with this option. When a character
4674 There is no option to specify these characters.
4682 NOTE: This option is set when 'compatible' is set.
4694 < It is not possible to get the value of this option with ":set key" or
4707 Setting this option to a valid keymap name has the side effect of
4723 The 'keymodel' option is set by the |:behave| command.
4731 help. (Note that previously setting the global option to the empty
4738 See |option-backslash| about including spaces and backslashes.
4741 < This option cannot be set from a |modeline| or in the |sandbox|, for
4749 This option allows switching your keyboard into a special language
4751 inserted directly. When in Normal mode the 'langmap' option takes
4755 This is the opposite of the 'keymap' option, where characters are
4759 This option cannot be set from a |modeline| or in the |sandbox|, for
4767 The 'langmap' option is a list of parts, separated with commas. Each
4785 this option. Note that this option can be changed at any time
4805 < This option must be set before loading menus, switching on filetype
4807 this option has no effect. But you could do this: >
4829 'langmap' disables some of your mappings, try resetting this option.
4830 This option defaults to on for backwards compatibility. Set it off if
4836 The value of this option influences when the last window will have a
4847 When this option is set, the screen will not be redrawn while
4862 of 'showbreak' is used to put in front of wrapped lines. This option
4863 is not used when the 'wrap' option is off.
4874 option will cause the window size to be changed. When you only want
4880 If you get fewer lines than expected, check the 'guiheadroom' option.
4881 When you set this option and Vim is unable to change the physical
4909 This option is not used when 'paste' is set.
4925 option.
5028 This option can be reset in your |vimrc| file to disable the loading
5031 line arguments reset this option. See |-u| and |--noplugin|.
5041 This option cannot be set from a |modeline| or in the |sandbox|, for
5055 WARNING: Switching this option off most likely breaks plugins! That
5076 See |option-backslash| about including spaces and backslashes.
5077 This option cannot be set from a |modeline| or in the |sandbox|, for
5100 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5103 Environment variables are expanded |:set_env|. See |option-backslash|
5112 < This option cannot be set from a |modeline| or in the |sandbox|, for
5148 Even when this option is set to 2 you can still edit text with more
5226 option has no direct effect, the menu must be refreshed first.
5266 This option cannot be set from a |modeline| or in the |sandbox|.
5280 modeline. Check the option for whether it is affected by
5282 This option cannot be set from a |modeline| or in the |sandbox|, for
5305 When on, the buffer is considered to be modified. This option is set
5309 option. But undoing changes that were made before writing the
5310 buffer will set the option again, since the text is different from
5315 values to the current values and the 'modified' option will be
5318 This option is not set when a change is made to the buffer as the
5322 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5331 the |more-prompt|. When this option is off there are no pauses, the
5333 NOTE: This option is set to the Vi default value when 'compatible' is
5358 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5369 Also see the 'clipboard' option.
5423 The 'mousemodel' option is set by the |:behave| command.
5432 This option tells Vim what the mouse pointer should look like in
5433 different modes. The option is a comma separated list of parts, much
5508 This option cannot be set from a |modeline| or in the |sandbox|, for
5520 This option cannot be set from a |modeline| or in the |sandbox|, for
5530 NOTE: This option is set to the Vim default value when 'compatible'
5567 Print the line number in front of each line. When the 'n' option is
5570 The 'numberwidth' option can be used to set the room used for the line
5577 The 'relativenumber' option changes the displayed number to be
5595 when the 'number' or 'relativenumber' option is set or printing lines
5604 NOTE: This option is set to the Vi default value when 'compatible' is
5612 This option specifies a function to be used for Insert mode omni
5616 This option is usually set by a filetype plugin:
5618 This option cannot be set from a |modeline| or in the |sandbox|, for
5636 This option specifies a function to be called by the |g@| operator.
5639 |option-value-function| for more information.
5641 This option cannot be set from a |modeline| or in the |sandbox|, for
5648 This option was supported on RISC OS, which has been removed.
5668 Setting this option is useful when using Vim in a terminal, where Vim
5673 This option is reset when starting the GUI. Thus if you set it in
5677 When the 'paste' option is switched on (also when it was already on):
5697 NOTE: When you start editing another file while the 'paste' option is
5700 set the 'paste' option again.
5701 When the 'paste' option is reset the mentioned options are restored to
5705 the 'pastetoggle' option to toggle the 'paste' option with some key.
5711 option. This is like specifying a mapping: >
5746 name of the original file with the string in the 'patchmode' option
5747 appended. This option should start with a dot. Use a string like
5767 option may be relative or absolute.
5789 - Careful with '\' characters, type two to get one in the option: >
5820 This option cannot be set from a |modeline| or in the |sandbox|, for
5829 enabled, in which case only spaces are used). Enabling this option
5836 NOTE: This option is reset when 'compatible' is set.
5865 Identifies the preview window. Only one window can have this option
5875 See |pdev-option|.
5876 This option cannot be set from a |modeline| or in the |sandbox|, for
5885 See |penc-option|.
5893 See |pexpr-option|.
5894 This option cannot be set from a |modeline| or in the |sandbox|, for
5903 See |pfn-option|.
5911 See |pheader-option|.
5919 See |pmbcs-option|.
5927 See |pmbfn-option|.
5934 See |popt-option|.
5962 This option cannot be set from a |modeline| or in the |sandbox|, for
5975 This option cannot be set from a |modeline| or in the |sandbox|, for
5986 This option cannot be set from a |modeline| or in the |sandbox|, for
5999 This option cannot be set from a |modeline| or in the |sandbox|, for
6026 This option cannot be set from a |modeline| or in the |sandbox|, for
6034 This option specifies a function to be used to get the text to display
6040 |lambda| or a |Funcref|. See |option-value-function| for more
6043 This option cannot be set from a |modeline| or in the |sandbox|, for
6051 When one of the characters in this option is found inside a string,
6061 When using ":w!" the 'readonly' option is reset for the current
6063 When using the ":view" command the 'readonly' option is set for the
6106 When the 'n' option is excluded from 'cpoptions' a wrapped
6109 The 'numberwidth' option can be used to set the room used for the line
6126 this option at the default "on". Only switch it off when working with
6211 NOTE: With this option, you can display colored emoji
6255 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6257 NOTE: This option is reset when 'compatible' is set.
6258 This option is reset when 'paste' is set and restored when 'paste' is
6268 Using this option, it is possible to edit files for languages that
6270 This option is per window, so it is possible to edit mixed files
6281 Each word in this option enables the command line editing to work in
6287 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6297 This option cannot be set from a |modeline| or in the |sandbox|, for
6316 this option takes precedence over 'ruler' and 'rulerformat'
6323 This option is reset when 'paste' is set and restored when 'paste' is
6327 NOTE: This option is reset when 'compatible' is set.
6334 When this option is not empty, it determines the content of the ruler
6335 string, as displayed for the 'ruler' option.
6336 The format of this option is like that of 'statusline'.
6337 This option cannot be set in a modeline when 'modelineexpr' is off.
6433 This option cannot be set from a |modeline| or in the |sandbox|, for
6442 'tabline' option after setting the 'scroll' option.
6450 See also |scroll-binding|. When this option is set, the current
6452 this option set) scroll. This option is useful for viewing the
6454 See |'scrollopt'| for options that determine how this option should be
6456 This option is mostly reset when splitting a window to edit another
6464 When using the scroll wheel and this option is set, the window under
6465 the mouse pointer is scrolled. With this option off the current
6467 Systems other than MS-Windows always behave like this option is on.
6478 NOTE: This option is set to 1 when 'compatible' is set.
6493 NOTE: This option is set to 0 when 'compatible' is set.
6539 problems, or when the 'exrc' option is off. On Unix this option is
6543 This option cannot be set from a |modeline| or in the |sandbox|, for
6549 This option defines the behavior of the selection. It is only used
6567 The 'selection' option is set by the |:behave| command.
6579 The 'selectmode' option is set by the |:behave| command.
6636 See |option-backslash| about including spaces and backslashes.
6643 each space (to avoid ending the option value). Also note that the
6648 option from $SHELL): >
6660 < This option cannot be set from a |modeline| or in the |sandbox|, for
6672 to reduce the need to set this option by the user.
6675 See |option-backslash| about including spaces and backslashes.
6677 This option cannot be set from a |modeline| or in the |sandbox|, for
6688 error file. See also |:make_makeprg|. See |option-backslash| about
6692 of this option).
6698 in a file and echoed to the screen. If the 'shell' option is "csh" or
6700 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6702 means that stderr is also included. Before using the 'shell' option a
6704 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6706 The initialization of this option is done after reading the ".vimrc"
6707 and the other initializations, so that when the 'shell' option is set
6708 there, the 'shellpipe' option changes automatically, unless it was
6715 In the future pipes may be used for filtering and this option will
6717 This option cannot be set from a |modeline| or in the |sandbox|, for
6730 This option cannot be set from a |modeline| or in the |sandbox|, for
6738 file. See also |:!|. See |option-backslash| about including spaces
6742 of this option).
6743 The default is ">". For Unix, if the 'shell' option is "csh" or
6745 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6752 The initialization of this option is done after reading the ".vimrc"
6753 and the other initializations, so that when the 'shell' option is set
6754 there, the 'shellredir' option changes automatically unless it was
6756 In the future pipes may be used for filtering and this option will
6758 This option cannot be set from a |modeline| or in the |sandbox|, for
6769 Note that setting or resetting this option has no effect for some
6770 existing file names, thus this option needs to be set before opening
6792 The `system()` function does not respect this option and always uses
6794 NOTE: This option is set to the Vim default value when 'compatible'
6801 On the Amiga this option influences the way how the commands work
6816 option will be escaped with a '^' character. This makes it possible
6840 'shell', to reduce the need to set this option by the user. See
6842 This option cannot be set from a |modeline| or in the |sandbox|, for
6851 NOTE: This option is reset when 'compatible' is set.
6865 This option helps to avoid all the |hit-enter| prompts caused by file
6917 NOTE: This option is set to the Vi default value when 'compatible' is
6925 option is on, dots in file names are replaced with underscores when
6926 adding an extension (".~" or ".swp"). This option is useful
6960 option off if your terminal is slow.
6968 NOTE: This option is set to the Vi default value when 'compatible' is
6991 This option is reset when 'paste' is set and restored when 'paste' is
6997 The 'matchpairs' option can be used to specify the characters to show
7013 NOTE: This option is set to the Vi default value when 'compatible' is
7019 The value of this option specifies when the line with tab page labels
7032 the 'wrap' option is off and the cursor is moved off of the screen.
7042 right of the cursor if 'nowrap' is set. Setting this option to a
7045 horizontally (except at beginning of the line). Setting this option
7053 < NOTE: This option is set to 0 when 'compatible' is set.
7078 Override the 'ignorecase' option if the search pattern contains upper
7080 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
7084 NOTE: This option is reset when 'compatible' is set.
7110 NOTE: This option is reset when 'compatible' is set.
7111 This option is reset when 'paste' is set and restored when 'paste' is
7125 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
7127 This option is reset when 'paste' is set and restored when 'paste' is
7129 NOTE: This option is reset when 'compatible' is set.
7142 'softtabstop' is set to 0 when the 'paste' option is set and restored
7148 NOTE: This option is set to 0 when 'compatible' is set.
7170 When this check is not wanted make this option empty.
7172 Be careful with special characters, see |option-backslash| about
7174 To set this option automatically depending on the language, see
7189 When a word is added while this option is empty Vim will set it for
7200 This option cannot be set from a |modeline| or in the |sandbox|, for
7208 A comma separated list of word list names. When the 'spell' option is
7243 After this option has been set successfully, Vim will source the files
7314 'verbose' option to a non-zero value.
7320 This option cannot be set from a |modeline| or in the |sandbox|, for
7348 NOTE: This option is set when 'compatible' is set.
7355 When nonempty, this option determines the content of the status line.
7358 The option consists of printf style '%' items interspersed with
7364 When the option starts with "%!" then it is used as an expression,
7365 evaluated and the result is used as the option value. Example: >
7374 When there is error while evaluating the option then it will be made
7377 Note that the only effect of 'ruler' when this option is set (and
7425 N N Printer page number. (Only works in the 'printheader' option.)
7494 The 'statusline' option will be evaluated in the |sandbox| if set from
7495 a modeline, see |sandbox-option|.
7496 This option cannot be set in a modeline when 'modelineexpr' is off.
7503 setting an option without changing its value. Example: >
7540 separator, precede it with a backslash (see |option-backslash| about
7559 Use a swapfile for the buffer. This option can be reset when a
7575 This option is used together with 'bufhidden' and 'buftype' to
7581 When this option is not empty a swap file is synced to disk after
7583 When this option is empty parts of the swap file may be in memory and
7586 so the disadvantage of setting this option off is small. On some
7590 The 'fsync' option is used for the actual file.
7595 This option controls the behavior when switching between buffers.
7636 When this option is set, the syntax with this name is loaded, unless
7638 Otherwise this option does not always reflect the current syntax (the
7640 This option is most useful in a modeline, for a file which syntax is
7652 'filetype' option: >
7654 < What actually happens when setting the 'syntax' option is that the
7656 This option is not copied to another buffer, independent of the 's' or
7663 When nonempty, this option determines the content of the tab pages
7668 option and only when there is no GUI tab line. When 'e' is in
7679 This option cannot be set in a modeline when 'modelineexpr' is off.
7696 |:retab| command, and 'softtabstop' option.
7732 'tagbsearch' option need to be switched off.
7771 This option doesn't affect commands that find all matching tags (e.g.,
7777 This option specifies how case is handled when searching the tags
7779 followic Follow the 'ignorecase' option
7784 NOTE: This option is set to the Vi default value when 'compatible' is
7792 This option specifies a function to be used to perform tag searches.
7807 NOTE: This option is set to the Vi default value when 'compatible' is
7816 (see |option-backslash| about including spaces and backslashes).
7820 |tags-option|.
7845 Resetting this option is useful when using a ":tag" command in a
7856 This option cannot be set from a |modeline| or in the |sandbox|, for
7884 Setting this option implies that 'rightleft' will not be set when
7888 This option is reset when the GUI is started.
7905 When empty, the same encoding is used as for the 'encoding' option.
7909 The value for this option must be supported by internal conversions or
7926 Requires a ISO-8613-3 compatible terminal. If setting this option
7936 NOTE: This option is reset when 'compatible' is set.
8010 When set: Add 's' flag to 'shortmess' option (this makes the message
8012 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8018 This option is obsolete. Use 'fileformats'.
8022 NOTE: This option is set to the Vi default value when 'compatible' is
8029 This option is obsolete. Use 'fileformat'.
8040 'textwidth' is set to 0 when the 'paste' option is set and restored
8045 NOTE: This option is set to 0 when 'compatible' is set.
8054 This option is not used if 'thesaurusfunc' is set, either for the
8059 name. See |option-backslash| about using backslashes. The use of
8062 another default. Backticks cannot be used in this option for security
8070 This option specifies a function to be used for thesaurus completion
8073 This option cannot be set from a |modeline| or in the |sandbox|, for
8080 NOTE: This option is reset when 'compatible' is set.
8104 be changed with the 'timeoutlen' option.
8110 sequences not timing out in 1 second, set the 'ttimeout' option and
8111 reset the 'timeout' option.
8157 terminals with a non-empty 't_ts' option - these are Unix xterm and
8187 'titlelen' is also used for the 'titlestring' option.
8194 This option will be used for the window title when exiting Vim if the
8197 This option cannot be set from a |modeline| or in the |sandbox|, for
8204 When this option is not empty, it will be used for the title of the
8205 window. This happens only when the 'title' option is on.
8208 non-empty 't_ts' option).
8212 When this option contains printf-style '%' items, they will be
8214 This option cannot be set in a modeline when 'modelineexpr' is off.
8235 The contents of this option controls various toolbar settings. The
8252 'toolbar' is empty, this option is ignored. If you want to disable
8253 the toolbar, you need to set the 'guioptions' option. For example: >
8280 When this option is changed, you should set the 'term' option next for
8284 Rationale: The default for this option is "on", because the builtin
8345 beyond 223. This option is backward compatible with
8357 This option is automatically set to "xterm", when the 'term' option is
8401 This option cannot be set from a |modeline| or in the |sandbox|, for
8416 NOTE: This option is reset when 'compatible' is set.
8445 The save only happens when this option is negative or when the number
8446 of lines is smaller than the value of this option.
8447 Set this option to zero to disable undo for a reload.
8452 this option to a lower value if you run out of memory.
8460 Vim with the "-n" option, see |startup|. When editing in readonly
8461 mode this option will be initialized to 10000.
8467 This option has no meaning in buffers where |'buftype'| is "nofile"
8532 This option can also be set with the "-V" argument. See |-V|.
8533 This option is also set by the |:verbose| command.
8535 When the 'verbosefile' option is set then the verbose messages are not
8559 This option cannot be set from a |modeline| or in the |sandbox|, for
8662 the 'n'. Must be at the end of the option! If the
8663 'viminfofile' option is set, that file name overrides the one
8665 expanded when opening the file, not when setting the option.
8700 This option cannot be set from a |modeline| or in the |sandbox|, for
8702 NOTE: This option is set to the Vim default value when 'compatible'
8712 This option can be set with the |-i| command line flag. The |--clean|
8714 This option cannot be set from a |modeline| or in the |sandbox|, for
8746 NOTE: This option is set to "" when 'compatible' is set.
8784 This option has the same effect as the 't_xs' terminal option.
8818 NOTE: This option is set to the Vi default value when 'compatible' is
8830 Although 'wc' is a number option, you can set it to a special key: >
8832 < NOTE: This option is set to the Vi default value when 'compatible' is
8840 keys suitable for this option by looking at |ex-edit-index|. Normally
8982 entering special characters. This option tells what to do:
8993 This option is not used for <F10>; on Win32 and with GTK <F10> will
9026 to create only two windows, set the option after startup is done,
9059 This option is only checked when making a window smaller. Don't use a
9073 This option is only checked when making a window smaller. Don't use a
9087 This option cannot be set from a |modeline| or in the |sandbox|, for
9106 This option changes how text is displayed. It doesn't change the text
9119 This option can't be set from a |modeline| when the 'diff' option is
9130 When 'textwidth' is non-zero, this option is not used.
9131 This option is set to 0 when 'paste' is set and restored when 'paste'
9160 the file was successfully written, unless the 'backup' option is
9162 WARNING: Switching this option off means that when Vim fails to write
9165 this option if your file system is almost full and it makes the write
9171 NOTE: This option is set to the default value when 'compatible' is