Bram Moolenaar | bb76f24 | 2016-09-12 14:24:39 +0200 | [diff] [blame] | 1 | *pi_paren.txt* For Vim version 8.0. Last change: 2013 May 08 |
Bram Moolenaar | 5e3cb7e | 2006-02-27 23:58:35 +0000 | [diff] [blame] | 2 | |
| 3 | |
| 4 | VIM REFERENCE MANUAL by Bram Moolenaar |
| 5 | |
| 6 | |
| 7 | Highlighting matching parens *matchparen* |
| 8 | |
| 9 | The functionality mentioned here is a |standard-plugin|. |
| 10 | This plugin is only available if 'compatible' is not set. |
| 11 | |
| 12 | You can avoid loading this plugin by setting the "loaded_matchparen" variable: > |
| 13 | :let loaded_matchparen = 1 |
| 14 | |
Bram Moolenaar | fa2e044 | 2007-08-18 16:21:50 +0000 | [diff] [blame] | 15 | The plugin installs CursorMoved, CursorMovedI and WinEnter autocommands to |
| 16 | redefine the match highlighting. |
Bram Moolenaar | 5e3cb7e | 2006-02-27 23:58:35 +0000 | [diff] [blame] | 17 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 18 | *:NoMatchParen* *:DoMatchParen* |
Bram Moolenaar | 5e3cb7e | 2006-02-27 23:58:35 +0000 | [diff] [blame] | 19 | To disable the plugin after it was loaded use this command: > |
| 20 | |
| 21 | :NoMatchParen |
| 22 | |
| 23 | And to enable it again: > |
| 24 | |
| 25 | :DoMatchParen |
| 26 | |
Bram Moolenaar | fd2ac76 | 2006-03-01 22:09:21 +0000 | [diff] [blame] | 27 | The highlighting used is MatchParen. You can specify different colors with |
Bram Moolenaar | 5e3cb7e | 2006-02-27 23:58:35 +0000 | [diff] [blame] | 28 | the ":highlight" command. Example: > |
| 29 | |
Bram Moolenaar | fd2ac76 | 2006-03-01 22:09:21 +0000 | [diff] [blame] | 30 | :hi MatchParen ctermbg=blue guibg=lightblue |
Bram Moolenaar | 5e3cb7e | 2006-02-27 23:58:35 +0000 | [diff] [blame] | 31 | |
| 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. |
| 36 | |
| 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. |
| 41 | |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 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. |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 47 | - 'synmaxcol' times 2 bytes before or after the cursor to avoid a delay |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 48 | in a long line with syntax highlighting. |
Bram Moolenaar | ad3b366 | 2013-05-17 18:14:19 +0200 | [diff] [blame] | 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. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 53 | |
| 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. |
| 58 | |
Bram Moolenaar | 5e3cb7e | 2006-02-27 23:58:35 +0000 | [diff] [blame] | 59 | ============================================================================== |
| 60 | vim:tw=78:ts=8:ft=help:norl: |