Mercurial > vim

comparison runtime/doc/options.txt @ 18912:ccd16426a1f9 v8.2.0017

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 8.2.0017: OS/2 and MS-DOS are still mentioned Commit: https://github.com/vim/vim/commit/6f345a1458df2db03fba7863492404e9dc8b817c Author: Bram Moolenaar <Bram@vim.org> Date: Tue Dec 17 21:27:18 2019 +0100 patch 8.2.0017: OS/2 and MS-DOS are still mentioned Problem: OS/2 and MS-DOS are still mentioned, even though support was removed long ago. Solution: Update documentation. (Yegappan Lakshmanan, closes #5368)
author Bram Moolenaar <Bram@vim.org>
date Tue, 17 Dec 2019 21:30:04 +0100
parents af69c9335223
children 180a1c5175f6
comparison
equal deleted inserted replaced
18911:69640323f7ca 18912:ccd16426a1f9
1 *options.txt* For Vim version 8.2. Last change: 2019 Dec 06 1 *options.txt* For Vim version 8.2. Last change: 2019 Dec 17
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
707 file. Therefore, when a CJK font is used for GUI Vim or 707 file. Therefore, when a CJK font is used for GUI Vim or
708 Vim is running inside a terminal (emulators) that uses a CJK font 708 Vim is running inside a terminal (emulators) that uses a CJK font
709 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), 709 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
710 this option should be set to "double" to match the width perceived 710 this option should be set to "double" to match the width perceived
711 by Vim with the width of glyphs in the font. Perhaps it also has 711 by Vim with the width of glyphs in the font. Perhaps it also has
712 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP 712 to be set to "double" under CJK MS-Windows 2k/XP
713 when the system locale is set to one of CJK locales. See Unicode 713 when the system locale is set to one of CJK locales. See Unicode
714 Standard Annex #11 (http://www.unicode.org/reports/tr11). 714 Standard Annex #11 (http://www.unicode.org/reports/tr11).
715 715
716 Vim may set this option automatically at startup time when Vim is 716 Vim may set this option automatically at startup time when Vim is
717 compiled with the |+termresponse| feature and if |t_u7| is set to the 717 compiled with the |+termresponse| feature and if |t_u7| is set to the
874 (because the window needs to be opened to find the actual background 874 (because the window needs to be opened to find the actual background
875 color). To get around this, force the GUI window to be opened by 875 color). To get around this, force the GUI window to be opened by
876 putting a ":gui" command in the .gvimrc file, before where the value 876 putting a ":gui" command in the .gvimrc file, before where the value
877 of 'background' is used (e.g., before ":syntax on"). 877 of 'background' is used (e.g., before ":syntax on").
878 878
879 For MS-DOS, Windows and OS/2 the default is "dark". 879 For MS-Windows the default is "dark".
880 For other systems "dark" is used when 'term' is "linux", 880 For other systems "dark" is used when 'term' is "linux",
881 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark 881 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
882 background. Otherwise the default is "light". 882 background. Otherwise the default is "light".
883 883
884 The |:terminal| command and the |term_start()| function use the 884 The |:terminal| command and the |term_start()| function use the
1768 'delcombine' + off unicode: delete whole char combination 1768 'delcombine' + off unicode: delete whole char combination
1769 'digraph' + off no digraphs 1769 'digraph' + off no digraphs
1770 'esckeys' & off no <Esc>-keys in Insert mode 1770 'esckeys' & off no <Esc>-keys in Insert mode
1771 'expandtab' + off tabs not expanded to spaces 1771 'expandtab' + off tabs not expanded to spaces
1772 'fileformats' & "" no automatic file format detection, 1772 'fileformats' & "" no automatic file format detection,
1773 "dos,unix" except for DOS, Windows and OS/2 1773 "dos,unix" except for MS-Windows
1774 'formatexpr' + "" use 'formatprg' for auto-formatting 1774 'formatexpr' + "" use 'formatprg' for auto-formatting
1775 'formatoptions' & "vt" Vi compatible formatting 1775 'formatoptions' & "vt" Vi compatible formatting
1776 'gdefault' + off no default 'g' flag for ":s" 1776 'gdefault' + off no default 'g' flag for ":s"
1777 'history' & 0 no commandline history 1777 'history' & 0 no commandline history
1778 'hkmap' + off no Hebrew keyboard mapping 1778 'hkmap' + off no Hebrew keyboard mapping
1880 local to buffer 1880 local to buffer
1881 {only for MS-Windows} 1881 {only for MS-Windows}
1882 When this option is set it overrules 'shellslash' for completion: 1882 When this option is set it overrules 'shellslash' for completion:
1883 - When this option is set to "slash", a forward slash is used for path 1883 - When this option is set to "slash", a forward slash is used for path
1884 completion in insert mode. This is useful when editing HTML tag, or 1884 completion in insert mode. This is useful when editing HTML tag, or
1885 Makefile with 'noshellslash' on Windows. 1885 Makefile with 'noshellslash' on MS-Windows.
1886 - When this option is set to "backslash", backslash is used. This is 1886 - When this option is set to "backslash", backslash is used. This is
1887 useful when editing a batch file with 'shellslash' set on Windows. 1887 useful when editing a batch file with 'shellslash' set on MS-Windows.
1888 - When this option is empty, same character is used as for 1888 - When this option is empty, same character is used as for
1889 'shellslash'. 1889 'shellslash'.
1890 For Insert mode completion the buffer-local value is used. For 1890 For Insert mode completion the buffer-local value is used. For
1891 command line completion the global value is used. 1891 command line completion the global value is used.
1892 1892
4440 When executing commands with |:normal| 'insertmode' is not used. 4440 When executing commands with |:normal| 'insertmode' is not used.
4441 4441
4442 NOTE: This option is reset when 'compatible' is set. 4442 NOTE: This option is reset when 'compatible' is set.
4443 4443
4444 *'isfname'* *'isf'* 4444 *'isfname'* *'isf'*
4445 'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2: 4445 'isfname' 'isf' string (default for Win32:
4446 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" 4446 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4447 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" 4447 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4448 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" 4448 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4449 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" 4449 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4450 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") 4450 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4494 " -~,^,,9" All characters from space to '~', excluding 4494 " -~,^,,9" All characters from space to '~', excluding
4495 comma, plus <Tab>. 4495 comma, plus <Tab>.
4496 See |option-backslash| about including spaces and backslashes. 4496 See |option-backslash| about including spaces and backslashes.
4497 4497
4498 *'isident'* *'isi'* 4498 *'isident'* *'isi'*
4499 'isident' 'isi' string (default for MS-DOS, Win32 and OS/2: 4499 'isident' 'isi' string (default for Win32:
4500 "@,48-57,_,128-167,224-235" 4500 "@,48-57,_,128-167,224-235"
4501 otherwise: "@,48-57,_,192-255") 4501 otherwise: "@,48-57,_,192-255")
4502 global 4502 global
4503 The characters given by this option are included in identifiers. 4503 The characters given by this option are included in identifiers.
4504 Identifiers are used in recognizing environment variables and after a 4504 Identifiers are used in recognizing environment variables and after a
4508 Careful: If you change this option, it might break expanding 4508 Careful: If you change this option, it might break expanding
4509 environment variables. E.g., when '/' is included and Vim tries to 4509 environment variables. E.g., when '/' is included and Vim tries to
4510 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. 4510 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4511 4511
4512 *'iskeyword'* *'isk'* 4512 *'iskeyword'* *'isk'*
4513 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: 4513 'iskeyword' 'isk' string (Vim default for Win32:
4514 "@,48-57,_,128-167,224-235" 4514 "@,48-57,_,128-167,224-235"
4515 otherwise: "@,48-57,_,192-255" 4515 otherwise: "@,48-57,_,192-255"
4516 Vi default: "@,48-57,_") 4516 Vi default: "@,48-57,_")
4517 local to buffer 4517 local to buffer
4518 Keywords are used in searching and recognizing with many commands: 4518 Keywords are used in searching and recognizing with many commands:
4528 uses |:syn-iskeyword|. 4528 uses |:syn-iskeyword|.
4529 NOTE: This option is set to the Vi default value when 'compatible' is 4529 NOTE: This option is set to the Vi default value when 'compatible' is
4530 set and to the Vim default value when 'compatible' is reset. 4530 set and to the Vim default value when 'compatible' is reset.
4531 4531
4532 *'isprint'* *'isp'* 4532 *'isprint'* *'isp'*
4533 'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh: 4533 'isprint' 'isp' string (default for Win32 and Macintosh:
4534 "@,~-255"; otherwise: "@,161-255") 4534 "@,~-255"; otherwise: "@,161-255")
4535 global 4535 global
4536 The characters given by this option are displayed directly on the 4536 The characters given by this option are displayed directly on the
4537 screen. It is also used for "\p" in a |pattern|. The characters from 4537 screen. It is also used for "\p" in a |pattern|. The characters from
4538 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, 4538 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5482 5482
5483 5483
5484 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* 5484 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
5485 'opendevice' 'odev' boolean (default off) 5485 'opendevice' 'odev' boolean (default off)
5486 global 5486 global
5487 {only for MS-DOS, MS-Windows and OS/2} 5487 {only for MS-Windows}
5488 Enable reading and writing from devices. This may get Vim stuck on a 5488 Enable reading and writing from devices. This may get Vim stuck on a
5489 device that can be opened but doesn't actually do the I/O. Therefore 5489 device that can be opened but doesn't actually do the I/O. Therefore
5490 it is off by default. 5490 it is off by default.
5491 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also 5491 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5492 result in editing a device. 5492 result in editing a device.
5614 recognized as a compressed file. 5614 recognized as a compressed file.
5615 Only normal file name characters can be used, "/\*?[|<>" are illegal. 5615 Only normal file name characters can be used, "/\*?[|<>" are illegal.
5616 5616
5617 *'path'* *'pa'* *E343* *E345* *E347* *E854* 5617 *'path'* *'pa'* *E343* *E345* *E347* *E854*
5618 'path' 'pa' string (default on Unix: ".,/usr/include,," 5618 'path' 'pa' string (default on Unix: ".,/usr/include,,"
5619 on OS/2: ".,/emx/include,,"
5620 other systems: ".,,") 5619 other systems: ".,,")
5621 global or local to buffer |global-local| 5620 global or local to buffer |global-local|
5622 This is a list of directories which will be searched when using the 5621 This is a list of directories which will be searched when using the
5623 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, 5622 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5624 provided that the file being searched for has a relative path (not 5623 provided that the file being searched for has a relative path (not
6193 Amiga: "home:vimfiles, 6192 Amiga: "home:vimfiles,
6194 $VIM/vimfiles, 6193 $VIM/vimfiles,
6195 $VIMRUNTIME, 6194 $VIMRUNTIME,
6196 $VIM/vimfiles/after, 6195 $VIM/vimfiles/after,
6197 home:vimfiles/after" 6196 home:vimfiles/after"
6198 PC, OS/2: "$HOME/vimfiles, 6197 PC: "$HOME/vimfiles,
6199 $VIM/vimfiles, 6198 $VIM/vimfiles,
6200 $VIMRUNTIME, 6199 $VIMRUNTIME,
6201 $VIM/vimfiles/after, 6200 $VIM/vimfiles/after,
6202 $HOME/vimfiles/after" 6201 $HOME/vimfiles/after"
6203 Macintosh: "$VIM:vimfiles, 6202 Macintosh: "$VIM:vimfiles,
6463 but the Windows version of Vim can source unix format scripts. 6462 but the Windows version of Vim can source unix format scripts.
6464 6463
6465 *'shell'* *'sh'* *E91* 6464 *'shell'* *'sh'* *E91*
6466 'shell' 'sh' string (default $SHELL or "sh", 6465 'shell' 'sh' string (default $SHELL or "sh",
6467 MS-DOS and Win32: "command.com" or 6466 MS-DOS and Win32: "command.com" or
6468 "cmd.exe", OS/2: "cmd") 6467 "cmd.exe")
6469 global 6468 global
6470 Name of the shell to use for ! and :! commands. When changing the 6469 Name of the shell to use for ! and :! commands. When changing the
6471 value also check these options: 'shelltype', 'shellpipe', 'shellslash' 6470 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6472 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. 6471 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
6473 It is allowed to give an argument to the command, e.g. "csh -f". 6472 It is allowed to give an argument to the command, e.g. "csh -f".
6590 security reasons. 6589 security reasons.
6591 6590
6592 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* 6591 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6593 'shellslash' 'ssl' boolean (default off) 6592 'shellslash' 'ssl' boolean (default off)
6594 global 6593 global
6595 {only for MSDOS, MS-Windows and OS/2} 6594 {only for MS-Windows}
6596 When set, a forward slash is used when expanding file names. This is 6595 When set, a forward slash is used when expanding file names. This is
6597 useful when a Unix-like shell is used instead of command.com or 6596 useful when a Unix-like shell is used instead of command.com or
6598 cmd.exe. Backward slashes can still be typed, but they are changed to 6597 cmd.exe. Backward slashes can still be typed, but they are changed to
6599 forward slashes by Vim. 6598 forward slashes by Vim.
6600 Note that setting or resetting this option has no effect for some 6599 Note that setting or resetting this option has no effect for some
7666 on Amiga: "amiga" 7665 on Amiga: "amiga"
7667 on BeOS: "beos-ansi" 7666 on BeOS: "beos-ansi"
7668 on Mac: "mac-ansi" 7667 on Mac: "mac-ansi"
7669 on MiNT: "vt52" 7668 on MiNT: "vt52"
7670 on MS-DOS: "pcterm" 7669 on MS-DOS: "pcterm"
7671 on OS/2: "os2ansi"
7672 on Unix: "ansi" 7670 on Unix: "ansi"
7673 on VMS: "ansi" 7671 on VMS: "ansi"
7674 on Win 32: "win32") 7672 on Win 32: "win32")
7675 global 7673 global
7676 Name of the terminal. Used for choosing the terminal control 7674 Name of the terminal. Used for choosing the terminal control
7825 reset, 'fileformats' is made empty. 7823 reset, 'fileformats' is made empty.
7826 NOTE: This option is set to the Vi default value when 'compatible' is 7824 NOTE: This option is set to the Vi default value when 'compatible' is
7827 set and to the Vim default value when 'compatible' is reset. 7825 set and to the Vim default value when 'compatible' is reset.
7828 7826
7829 *'textmode'* *'tx'* *'notextmode'* *'notx'* 7827 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7830 'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on, 7828 'textmode' 'tx' boolean (Win32: default on,
7831 others: default off) 7829 others: default off)
7832 local to buffer 7830 local to buffer
7833 This option is obsolete. Use 'fileformat'. 7831 This option is obsolete. Use 'fileformat'.
7834 For backwards compatibility, when 'textmode' is set, 'fileformat' is 7832 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7835 set to "dos". When 'textmode' is reset, 'fileformat' is set to 7833 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8213 before a reload to be saved for undo. 8211 before a reload to be saved for undo.
8214 When 'undofile' is turned off the undo file is NOT deleted. 8212 When 'undofile' is turned off the undo file is NOT deleted.
8215 NOTE: This option is reset when 'compatible' is set. 8213 NOTE: This option is reset when 'compatible' is set.
8216 8214
8217 *'undolevels'* *'ul'* 8215 *'undolevels'* *'ul'*
8218 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, 8216 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, Win32)
8219 Win32 and OS/2)
8220 global or local to buffer |global-local| 8217 global or local to buffer |global-local|
8221 Maximum number of changes that can be undone. Since undo information 8218 Maximum number of changes that can be undone. Since undo information
8222 is kept in memory, higher numbers will cause more memory to be used. 8219 is kept in memory, higher numbers will cause more memory to be used.
8223 Nevertheless, a single change can already use a large amount of memory. 8220 Nevertheless, a single change can already use a large amount of memory.
8224 Set to 0 for Vi compatibility: One level of undo and "u" undoes 8221 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8341 Setting 'verbosefile' to a new value is like making it empty first. 8338 Setting 'verbosefile' to a new value is like making it empty first.
8342 The difference with |:redir| is that verbose messages are not 8339 The difference with |:redir| is that verbose messages are not
8343 displayed when 'verbosefile' is set. 8340 displayed when 'verbosefile' is set.
8344 8341
8345 *'viewdir'* *'vdir'* 8342 *'viewdir'* *'vdir'*
8346 'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32: 8343 'viewdir' 'vdir' string (default for Amiga and Win32:
8347 "$VIM/vimfiles/view", 8344 "$VIM/vimfiles/view",
8348 for Unix: "~/.vim/view", 8345 for Unix: "~/.vim/view",
8349 for Macintosh: "$VIM:vimfiles:view" 8346 for Macintosh: "$VIM:vimfiles:view"
8350 for VMS: "sys$login:vimfiles/view" 8347 for VMS: "sys$login:vimfiles/view"
8351 for RiscOS: "Choices:vimfiles/view") 8348 for RiscOS: "Choices:vimfiles/view")
8371 global values for local options) 8368 global values for local options)
8372 localoptions same as "options" 8369 localoptions same as "options"
8373 slash backslashes in file names replaced with forward 8370 slash backslashes in file names replaced with forward
8374 slashes 8371 slashes
8375 unix with Unix end-of-line format (single <NL>), even when 8372 unix with Unix end-of-line format (single <NL>), even when
8376 on Windows or DOS 8373 on MS-Windows
8377 curdir the window-local directory, if set with `:lcd` 8374 curdir the window-local directory, if set with `:lcd`
8378 8375
8379 "slash" and "unix" are useful on Windows when sharing view files 8376 "slash" and "unix" are useful on MS-Windows when sharing view files
8380 with Unix. The Unix version of Vim cannot source dos format scripts, 8377 with Unix. The Unix version of Vim cannot source dos format scripts,
8381 but the Windows version of Vim can source unix format scripts. 8378 but the MS-Windows version of Vim can source unix format scripts.
8382 8379
8383 *'viminfo'* *'vi'* *E526* *E527* *E528* 8380 *'viminfo'* *'vi'* *E526* *E527* *E528*
8384 'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS, 8381 'viminfo' 'vi' string (Vi default: "", Vim default for
8385 Windows and OS/2: '100,<50,s10,h,rA:,rB:, 8382 MS-Windows: '100,<50,s10,h,rA:,rB:,
8386 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: 8383 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8387 for others: '100,<50,s10,h) 8384 for others: '100,<50,s10,h)
8388 global 8385 global
8389 {not available when compiled without the |+viminfo| 8386 {not available when compiled without the |+viminfo|
8390 feature} 8387 feature}