Install vim74
[msysgit.git] / share / vim / vim74 / doc / pi_paren.txt
blob497186204f5c4fc604c7e5e4bfaf49c54e73a99d
1 *pi_paren.txt*  For Vim version 7.4.  Last change: 2013 May 08
4                   VIM REFERENCE MANUAL    by Bram Moolenaar
7 Highlighting matching parens                    *matchparen*
9 The functionality mentioned here is a |standard-plugin|.
10 This plugin is only available if 'compatible' is not set.
12 You can avoid loading this plugin by setting the "loaded_matchparen" variable: >
13         :let loaded_matchparen = 1
15 The plugin installs CursorMoved, CursorMovedI and WinEnter autocommands to
16 redefine the match highlighting.
18                                         *:NoMatchParen* *:DoMatchParen*
19 To disable the plugin after it was loaded use this command: >
21         :NoMatchParen
23 And to enable it again: >
25         :DoMatchParen
27 The highlighting used is MatchParen.  You can specify different colors with
28 the ":highlight" command.  Example: >
30         :hi MatchParen ctermbg=blue guibg=lightblue
32 The characters to be matched come from the 'matchpairs' option.  You can
33 change the value to highlight different matches.  Note that not everything is
34 possible.  For example, you can't highlight single or double quotes, because
35 the start and end are equal.
37 The syntax highlighting attributes are used.  When the cursor currently is not
38 in a string or comment syntax item, then matches inside string and comment
39 syntax items are ignored.  Any syntax items with "string" or "comment"
40 somewhere in their name are considered string or comment items.
42 The search is limited to avoid a delay when moving the cursor.  The limits
43 are:
44 - What is visible in the window.
45 - 100 lines above or below the cursor to avoid a long delay when there are
46   closed folds.
47 - 'synmaxcol' times 2 bytes before or after the cursor to avoid a delay
48   in a long line with syntax highlighting.
49 - A timeout of 300 msec (60 msec in Insert mode). This can be changed with the
50   g:matchparen_timeout and g:matchparen_insert_timeout variables and their
51   buffer-local equivalents b:matchparen_timeout and
52   b:matchparen_insert_timeout.
54 If you would like the |%| command to work better, the matchit plugin can be
55 used, see |matchit-install|.  This plugin also helps to skip matches in
56 comments.  This is unrelated to the matchparen highlighting, they use a
57 different mechanism.
59 ==============================================================================
60  vim:tw=78:ts=8:ft=help:norl: