Merged from the latest developing branch.
[MacVim.git] / runtime / doc / pi_paren.txt
blob942a486f9feb98d8100f6d4acae53a17ff2f92ca
1 *pi_paren.txt*  For Vim version 7.2.  Last change: 2008 Jun 16
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.
51 If you would like the |%| command to work better, the matchit plugin can be
52 used, see |matchit-install|.  This plugin also helps to skip matches in
53 comments.  This is unrelated to the matchparen highlighting, they use a
54 different mechanism.
56 ==============================================================================
57  vim:tw=78:ts=8:ft=help:norl: