annotate runtime/doc/pi_paren.txt @ 18486:9d887cad7315

Added tag v8.1.2237 for changeset 63ee3c2b140fe1b4801389872a8e47aec19d028b
author Bram Moolenaar <Bram@vim.org>
date Thu, 31 Oct 2019 20:00:04 +0100
parents 2f7e67dd088c
children af69c9335223
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13963
1174611ad715 Vim 8.1 release
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
1 *pi_paren.txt* For Vim version 8.1. Last change: 2013 May 08
694
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
2
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
3
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Bram Moolenaar
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
5
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
6
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
7 Highlighting matching parens *matchparen*
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
8
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
9 The functionality mentioned here is a |standard-plugin|.
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
10 This plugin is only available if 'compatible' is not set.
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
11
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
12 You can avoid loading this plugin by setting the "loaded_matchparen" variable: >
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
13 :let loaded_matchparen = 1
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
14
1368
048f26eb43a3 updated for version 7.1-082
vimboss
parents: 1261
diff changeset
15 The plugin installs CursorMoved, CursorMovedI and WinEnter autocommands to
048f26eb43a3 updated for version 7.1-082
vimboss
parents: 1261
diff changeset
16 redefine the match highlighting.
694
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
17
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1368
diff changeset
18 *:NoMatchParen* *:DoMatchParen*
694
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
19 To disable the plugin after it was loaded use this command: >
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
20
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
21 :NoMatchParen
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
22
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
23 And to enable it again: >
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
24
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
25 :DoMatchParen
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
26
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 694
diff changeset
27 The highlighting used is MatchParen. You can specify different colors with
694
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
28 the ":highlight" command. Example: >
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
29
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 694
diff changeset
30 :hi MatchParen ctermbg=blue guibg=lightblue
694
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
31
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
32 The characters to be matched come from the 'matchpairs' option. You can
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
33 change the value to highlight different matches. Note that not everything is
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
34 possible. For example, you can't highlight single or double quotes, because
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
35 the start and end are equal.
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
36
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
37 The syntax highlighting attributes are used. When the cursor currently is not
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
38 in a string or comment syntax item, then matches inside string and comment
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
39 syntax items are ignored. Any syntax items with "string" or "comment"
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
40 somewhere in their name are considered string or comment items.
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
41
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
42 The search is limited to avoid a delay when moving the cursor. The limits
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
43 are:
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
44 - What is visible in the window.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
45 - 100 lines above or below the cursor to avoid a long delay when there are
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
46 closed folds.
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 874
diff changeset
47 - 'synmaxcol' times 2 bytes before or after the cursor to avoid a delay
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
48 in a long line with syntax highlighting.
4437
eb6ab7e78925 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
49 - A timeout of 300 msec (60 msec in Insert mode). This can be changed with the
eb6ab7e78925 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
50 g:matchparen_timeout and g:matchparen_insert_timeout variables and their
eb6ab7e78925 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
51 buffer-local equivalents b:matchparen_timeout and
eb6ab7e78925 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
52 b:matchparen_insert_timeout.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1368
diff changeset
53
82b5078be2dd updated for version 7.2a
vimboss
parents: 1368
diff changeset
54 If you would like the |%| command to work better, the matchit plugin can be
82b5078be2dd updated for version 7.2a
vimboss
parents: 1368
diff changeset
55 used, see |matchit-install|. This plugin also helps to skip matches in
82b5078be2dd updated for version 7.2a
vimboss
parents: 1368
diff changeset
56 comments. This is unrelated to the matchparen highlighting, they use a
82b5078be2dd updated for version 7.2a
vimboss
parents: 1368
diff changeset
57 different mechanism.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1368
diff changeset
58
694
07d199fe02ed updated for version 7.0209
vimboss
parents:
diff changeset
59 ==============================================================================
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
60 vim:tw=78:ts=8:noet:ft=help:norl: