summaryrefslogtreecommitdiffstats
path: root/runtime/doc/pi_paren.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/pi_paren.txt')
-rw-r--r--runtime/doc/pi_paren.txt60
1 files changed, 60 insertions, 0 deletions
diff --git a/runtime/doc/pi_paren.txt b/runtime/doc/pi_paren.txt
new file mode 100644
index 0000000..719353f
--- /dev/null
+++ b/runtime/doc/pi_paren.txt
@@ -0,0 +1,60 @@
+*pi_paren.txt* For Vim version 9.1. Last change: 2013 May 08
+
+
+ VIM REFERENCE MANUAL by Bram Moolenaar
+
+
+Highlighting matching parens *matchparen*
+
+The functionality mentioned here is a |standard-plugin|.
+This plugin is only available if 'compatible' is not set.
+
+You can avoid loading this plugin by setting the "loaded_matchparen" variable: >
+ :let loaded_matchparen = 1
+
+The plugin installs CursorMoved, CursorMovedI and WinEnter autocommands to
+redefine the match highlighting.
+
+ *:NoMatchParen* *:DoMatchParen*
+To disable the plugin after it was loaded use this command: >
+
+ :NoMatchParen
+
+And to enable it again: >
+
+ :DoMatchParen
+
+The highlighting used is MatchParen. You can specify different colors with
+the ":highlight" command. Example: >
+
+ :hi MatchParen ctermbg=blue guibg=lightblue
+
+The characters to be matched come from the 'matchpairs' option. You can
+change the value to highlight different matches. Note that not everything is
+possible. For example, you can't highlight single or double quotes, because
+the start and end are equal.
+
+The syntax highlighting attributes are used. When the cursor currently is not
+in a string or comment syntax item, then matches inside string and comment
+syntax items are ignored. Any syntax items with "string" or "comment"
+somewhere in their name are considered string or comment items.
+
+The search is limited to avoid a delay when moving the cursor. The limits
+are:
+- What is visible in the window.
+- 100 lines above or below the cursor to avoid a long delay when there are
+ closed folds.
+- 'synmaxcol' times 2 bytes before or after the cursor to avoid a delay
+ in a long line with syntax highlighting.
+- A timeout of 300 msec (60 msec in Insert mode). This can be changed with the
+ g:matchparen_timeout and g:matchparen_insert_timeout variables and their
+ buffer-local equivalents b:matchparen_timeout and
+ b:matchparen_insert_timeout.
+
+If you would like the |%| command to work better, the matchit plugin can be
+used, see |matchit-install|. This plugin also helps to skip matches in
+comments. This is unrelated to the matchparen highlighting, they use a
+different mechanism.
+
+==============================================================================
+ vim:tw=78:ts=8:noet:ft=help:norl: