Mercurial > hg > RemoteEditor > vim7
diff runtime/doc/options.txt @ 34:e170173ecb68 current-release
before ack base protocol.
author | Shinji KONO <kono@ie.u-ryukyu.ac.jp> |
---|---|
date | Wed, 26 Nov 2008 15:02:10 +0900 |
parents | 76efa0be13f1 |
children | c16898406ff2 |
line wrap: on
line diff
--- a/runtime/doc/options.txt Mon Nov 10 01:13:56 2008 +0000 +++ b/runtime/doc/options.txt Wed Nov 26 15:02:10 2008 +0900 @@ -1,4 +1,4 @@ -*options.txt* For Vim version 7.1. Last change: 2007 Aug 10 +*options.txt* For Vim version 7.2. Last change: 2008 Aug 06 VIM REFERENCE MANUAL by Bram Moolenaar @@ -111,19 +111,31 @@ When 'verbose' is non-zero, displaying an option value will also tell where it was last set. Example: > :verbose set shiftwidth cindent? - shiftwidth=4 - Last set from modeline - cindent - Last set from /usr/local/share/vim/vim60/ftplugin/c.vim -This is only done when specific option values are requested, not for ":set -all" or ":set" without an argument. -When the option was set by hand there is no "Last set" message. There is only -one value for all local options with the same name. Thus the message applies -to the option name, not necessarily its value. +< shiftwidth=4 ~ + Last set from modeline ~ + cindent ~ + Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~ +This is only done when specific option values are requested, not for ":verbose +set all" or ":verbose set" without an argument. +When the option was set by hand there is no "Last set" message. When the option was set while executing a function, user command or autocommand, the script in which it was defined is reported. Note that an option may also have been set as a side effect of setting 'compatible'. +A few special texts: + Last set from modeline ~ + Option was set in a |modeline|. + Last set from --cmd argument ~ + Option was set with command line argument |--cmd| or +. + Last set from -c argument ~ + Option was set with command line argument |-c|, +, |-S| or + |-q|. + Last set from environment variable ~ + Option was set from an environment variable, $VIMINIT, + $GVIMINIT or $EXINIT. + Last set from error handler ~ + Option was cleared when evaluating it resulted in an error. + {not available when compiled without the +eval feature} *:set-termcap* *E522* @@ -265,7 +277,10 @@ Without argument: Display all local option's local values which are different from the default. When displaying a specific local option, show the - local value. For a global option the global value is + local value. For a global/local boolean option, when + the global value is being used, "--" is displayed + before the option name. + For a global option the global value is shown (but that might change in the future). {not in Vi} @@ -797,7 +812,7 @@ When 'background' is set Vim will adjust the default color groups for the new value. But the colors used for syntax highlighting will not - change. + change. *g:colors_name* When a color scheme is loaded (the "colors_name" variable is set) setting 'background' will cause the color scheme to be reloaded. If the color scheme adjusts to the value of 'background' this will work. @@ -1148,9 +1163,11 @@ *'browsedir'* *'bsdir'* 'browsedir' 'bsdir' string (default: "last") global - {not in Vi} {only for Motif and Win32 GUI} + {not in Vi} {only for Motif, Athena, GTK, Mac and + Win32 GUI} Which directory to use for the file browser: - last Use same directory as with last file browser. + last Use same directory as with last file browser, where a + file was opened or saved. buffer Use the directory of the related buffer. current Use the current directory. {path} Use the specified directory @@ -1263,7 +1280,8 @@ |+file_in_path| feature} This is a list of directories which will be searched when using the |:cd| and |:lcd| commands, provided that the directory being searched - for has a relative path (not starting with "/", "./" or "../"). + for has a relative path, not an absolute part starting with "/", "./" + or "../", the 'cdpath' option is not used then. The 'cdpath' option's value has the same form and semantics as |'path'|. Also see |file-searching|. The default value is taken from $CDPATH, with a "," prepended to look @@ -1343,7 +1361,7 @@ {not in Vi} {not available when compiled without the |+cindent| feature} - Enables automatic C program indenting See 'cinkeys' to set the keys + Enables automatic C program indenting. See 'cinkeys' to set the keys that trigger reindenting in insert mode and 'cinoptions' to set your preferred indent style. If 'indentexpr' is not empty, it overrules 'cindent'. @@ -1711,7 +1729,8 @@ tabs followed by spaces as required (unless |'expandtab'| is enabled, in which case only spaces are used). Enabling this option makes the new line copy whatever characters were used for indenting on the - existing line. If the new indent is greater than on the existing + existing line. 'expandtab' has no effect on these characters, a Tab + remains a Tab. If the new indent is greater than on the existing line, the remaining space is filled in the normal manner. NOTE: 'copyindent' is reset when 'compatible' is set. Also see 'preserveindent'. @@ -2273,6 +2292,8 @@ or "\\", the swap file name will be built from the complete path to the file with all path separators substituted to percent '%' signs. This will ensure file name uniqueness in the preserve directory. + On Win32, when a separating comma is following, you must use "//", + since "\\" will include the comma in the file name. - Spaces after the comma are ignored, other spaces are considered part of the directory name. To have a space at the start of a directory name, precede it with a backslash. @@ -2423,8 +2444,8 @@ global or local to buffer |global-local| {not in Vi} External program to use for "=" command. When this option is empty - the internal formatting functions are used ('lisp', 'cindent' or - 'indentexpr'). + the internal formatting functions are used; either 'lisp', 'cindent' + or 'indentexpr'. Environment variables are expanded |:set_env|. See |option-backslash| about including spaces and backslashes. This option cannot be set from a |modeline| or in the |sandbox|, for @@ -3362,7 +3383,7 @@ 'guitablabel' can be used to change the text in the labels. When 'e' is missing a non-GUI tab pages line may be used. The GUI tabs are only supported on some systems, currently - GTK, Motif and MS-Windows. + GTK, Motif, Mac OS/X and MS-Windows. *'go-f'* 'f' Foreground: Don't use fork() to detach the GUI from the shell where it was started. Use this for programs that wait for the @@ -3618,6 +3639,7 @@ When you get bored looking at the highlighted matches, you can turn it off with |:nohlsearch|. As soon as you use a search command, the highlighting comes back. + 'redrawtime' specifies the maximum time spent on finding matches. When the search pattern can match an end-of-line, Vim will try to highlight all of the matched text. However, this depends on where the search starts. This will be the first line in the window or the first @@ -3851,6 +3873,10 @@ original position when no match is found and when pressing <Esc>. You still need to finish the search command with <Enter> to move the cursor to the match. + When compiled with the |+reltime| feature Vim only searches for about + half a second. With a complicated pattern and/or a lot of text the + match may not be found. This is to avoid that Vim hangs while you + are typing the pattern. The highlighting can be set with the 'i' flag in 'highlight'. See also: 'hlsearch'. CTRL-L can be used to add one character from after the current match @@ -3912,12 +3938,13 @@ local to buffer {not in Vi} When doing keyword completion in insert mode |ins-completion|, and - 'ignorecase' is also on, the case of the match is adjusted. If the - typed text contains a lowercase letter where the match has an upper - case letter, the completed part is made lowercase. If the typed text - has no lowercase letters and the match has a lowercase letter where - the typed text has an uppercase letter, and there is a letter before - it, the completed part is made uppercase. + 'ignorecase' is also on, the case of the match is adjusted depending + on the typed text. If the typed text contains a lowercase letter + where the match has an upper case letter, the completed part is made + lowercase. If the typed text has no lowercase letters and the match + has a lowercase letter where the typed text has an uppercase letter, + and there is a letter before it, the completed part is made uppercase. + With 'noinfercase' the match is used as-is. *'insertmode'* *'im'* *'noinsertmode'* *'noim'* 'insertmode' 'im' boolean (default off) @@ -3962,6 +3989,10 @@ Multi-byte characters 256 and above are always included, only the characters up to 255 are specified with this option. For UTF-8 the characters 0xa0 to 0xff are included as well. + Think twice before adding white space to this option. Although a + space may appear inside a file name, the effect will be that Vim + doesn't know where a file name starts or ends when doing completion. + It most likely works better without a space in 'isfname'. Note that on systems using a backslash as path separator, Vim tries to do its best to make it work as you would expect. That is a bit @@ -3988,7 +4019,7 @@ are included. Normally these are the characters a to z and A to Z, plus accented characters. To include '@' itself use "@-@". Examples: "@,^a-z" All alphabetic characters, excluding lower - case letters. + case ASCII letters. "a-z,A-Z,@-@" All letters plus the '@' character. A comma can be included by using it where a character number is expected. Example: @@ -4612,8 +4643,9 @@ global {not in Vi} Enable the use of the mouse. Only works for certain terminals - (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console - with gpm). For using the mouse in the GUI, see |gui-mouse|. + (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with + sysmouse and Linux console with gpm). For using the mouse in the + GUI, see |gui-mouse|. The mouse can be enabled for different modes: n Normal mode v Visual mode @@ -4868,12 +4900,12 @@ name, datestamp and permissions. This option contains the extra information, the nature of which will vary between systems. The value of this option is usually set when the file is loaded, and - use to set the file type when file is written. + is used to set the operating system file type when file is written. It can affect the pattern matching of the automatic commands. |autocmd-osfiletypes| *'paragraphs'* *'para'* -'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp") +'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") global Specifies the nroff macros that separate paragraphs. These are pairs of two letters (see |object-motions|). @@ -4943,6 +4975,7 @@ Note that typing <F10> in paste mode inserts "<F10>", 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 "") @@ -4981,9 +5014,10 @@ global or local to buffer |global-local| {not in Vi} This is a list of directories which will be searched when using the - |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file - being searched for has a relative path (not starting with '/'). The - directories in the 'path' option may be relative or absolute. + |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, + provided that the file being searched for has a relative path (not + starting with "/", "./" or "../"). The directories in the 'path' + 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 @@ -5002,19 +5036,8 @@ - Environment variables are expanded |:set_env|. - When using |netrw.vim| URLs can be used. For example, adding "http://www.vim.org" will make ":find index.html" work. - - Search upwards and downwards in a directory tree: - 1) "*" matches a sequence of characters, e.g.: > - :set path=/usr/include/* -< means all subdirectories in /usr/include (but not /usr/include - itself). > - :set path=/usr/*c -< matches /usr/doc and /usr/src. - 2) "**" matches a subtree, up to 100 directories deep. Example: > - :set path=/home/user_x/src/** -< means search in the whole subtree under "/home/usr_x/src". - 3) If the path ends with a ';', this path is the startpoint - for upward search. - See |file-searching| for more info and exact syntax. + - Search upwards and downwards in a directory tree using "*", "**" and + ";". See |file-searching| for info and syntax. {not available when compiled without the |+path_extra| feature} - Careful with '\' characters, type two to get one in the option: > :set path=.,c:\\include @@ -5049,6 +5072,8 @@ enabled, in which case only spaces are used). Enabling this option means the indent will preserve as many existing characters as possible for indenting, and only add additional tabs or spaces as required. + 'expandtab' does not apply to the preserved white space, a Tab remains + a Tab. NOTE: When using ">>" multiple times the resulting indent is a mix of tabs and spaces. You might not like this. NOTE: 'preserveindent' is reset when 'compatible' is set. @@ -5185,6 +5210,18 @@ {not in Vi:} When using the ":view" command the 'readonly' option is set for the newly edited buffer. + *'redrawtime'* *'rdt'* +'redrawtime' 'rdt' number (default 2000) + global + {not in Vi} + {only available when compiled with the |+reltime| + feature} + The time in milliseconds for redrawing the display. This applies to + searching for patterns for 'hlsearch' and |:match| highlighting. + When redrawing takes more than this many milliseconds no further + matches will be highlighted. This is used to avoid that Vim hangs + when using a very complicated pattern. + *'remap'* *'noremap'* 'remap' boolean (default on) global @@ -5877,6 +5914,9 @@ pattern (if there is one) as possible matches. Thus, if you have matched a C function, you can see a template for what arguments are required (coding style permitting). + Note that this doesn't work well together with having "longest" in + 'completeopt', because the completion from the search pattern may not + match the typed text. *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* 'showmatch' 'sm' boolean (default off) @@ -6268,15 +6308,15 @@ directory. F S Full path to the file in the buffer. t S File name (tail) of file in the buffer. - m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off. + m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. M F Modified flag, text is ",+" or ",-". - r F Readonly flag, text is " [RO]". + r F Readonly flag, text is "[RO]". R F Readonly flag, text is ",RO". - h F Help buffer flag, text is " [help]". + h F Help buffer flag, text is "[help]". H F Help buffer flag, text is ",HLP". - w F Preview window flag, text is " [Preview]". + w F Preview window flag, text is "[Preview]". W F Preview window flag, text is ",PRV". - y F Type of file in the buffer, e.g., " [vim]". See 'filetype'. + y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. {not available when compiled without |+autocmd| feature} k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are @@ -6323,14 +6363,9 @@ to StatusLineNC for the statusline of non-current windows. The number N must be between 1 and 9. See |hl-User1..9| - Display of flags are controlled by the following heuristic: - If a flag text starts with comma it is assumed that it wants to - separate itself from anything but preceding plaintext. If it starts - with a space it is assumed that it wants to separate itself from - anything but other flags. That is: A leading comma is removed if the - preceding character stems from plaintext. A leading space is removed - if the preceding character stems from another active flag. This will - make a nice display when flags are used like in the examples below. + When displaying a flag, Vim removes the leading comma, if any, when + that flag comes right after plaintext. This will make a nice display + when flags are used like in the examples below. When all items in a group becomes an empty string (i.e. flags that are not set) and a minwid is not set for the group, the whole group will @@ -6461,6 +6496,8 @@ split If included, split the current window before loading a buffer. Otherwise: do not split, use current window. Supported in |quickfix| commands that display errors. + newtab Like "split", but open a new tab page. Overrules + "split" when both are present. *'synmaxcol'* *'smc'* 'synmaxcol' 'smc' number (default 3000) @@ -6585,7 +6622,7 @@ 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 command/ + !_TAG_FILE_SORTED 0 /some comment/ < [The whitespace before and after the '0' must be a single <Tab>] When a binary search was done and no match was found in any of the @@ -7072,7 +7109,7 @@ "xterm", when the terminal name doesn't start with "xterm", but it can handle xterm mouse codes. The "xterm2" value will be set if the xterm version is reported to be - 95 of higher. This only works when compiled with the |+termresponse| + 95 or higher. This only works when compiled with the |+termresponse| feature and if |t_RV| is set to the escape sequence to request the xterm version number. Otherwise "xterm2" must be set explicitly. If you do not want 'ttymouse' to be set to "xterm2" automatically, set @@ -7407,6 +7444,7 @@ {not in Vi} Character you have to type to start wildcard expansion in the command-line, as specified with 'wildmode'. + More info here: |cmdline-completion|. The character is not recognized when used inside a macro. See 'wildcharm' for that. Although 'wc' is a number option, you can set it to a special key: > @@ -7424,7 +7462,7 @@ you'll never actually type 'wildcharm', just use it in mappings that automatically invoke completion mode, e.g.: > :set wcm=<C-Z> - :cmap ss so $vim/sessions/*.vim<C-Z> + :cnoremap ss so $vim/sessions/*.vim<C-Z> < Then after typing :ss you can use CTRL-P & CTRL-N. *'wildignore'* *'wig'* @@ -7519,6 +7557,7 @@ < List all matches without completing, then each full match > :set wildmode=longest,list < Complete longest common string, then list alternatives. + More info here: |cmdline-completion|. *'wildoptions'* *'wop'* 'wildoptions' 'wop' string (default "") @@ -7579,13 +7618,17 @@ feature} Minimal number of lines for the current window. This is not a hard minimum, Vim will use fewer lines if there is not enough room. If the - current window is smaller, its size is increased, at the cost of the - height of other windows. Set it to 999 to make the current window - always fill the screen (although this has the drawback that ":all" - will create only two windows). Set it to a small number for normal - editing. - Minimum value is 1. - The height is not adjusted after one of the commands to change the + focus goes to a window that is smaller, its size is increased, at the + cost of the height of other windows. + Set 'winheight' to a small number for normal editing. + Set it to 999 to make the current window fill most of the screen. + Other windows will be only 'winminheight' high. This has the drawback + that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" + to create only two windows, set the option after startup is done, + using the |VimEnter| event: > + au VimEnter * set winheight=999 +< Minimum value is 1. + The height is not adjusted after one of the commands that change the height of the current window. 'winheight' applies to the current window. Use 'winminheight' to set the minimal height for other windows.