summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaxime Coste <frrrwww@gmail.com>2014-06-16 20:46:27 +0100
committerMaxime Coste <frrrwww@gmail.com>2014-06-16 20:46:27 +0100
commitcbcc05396bbadaae2f5710c59aeff9ef60095f7a (patch)
treea28bd2ebb3a34150c0961f7c3d4d3becde2c4a41
parentb8a205b858dbed727a1722e60219340bec9263ef (diff)
Complete hook documentation in README
-rw-r--r--README.asciidoc15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.asciidoc b/README.asciidoc
index 3d2e9858..cbe66bc6 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -730,9 +730,9 @@ Hooks
commands can be registred to be executed when certain events arise.
to register a hook, use the hook command.
-------------------------------------------------------
-:hook <scope> <hook_name> <filtering_regex> <commands>
-------------------------------------------------------
+-----------------------------------------------------------------------
+:hook [-group <group>] <scope> <hook_name> <filtering_regex> <commands>
+-----------------------------------------------------------------------
<scope> can be either global, buffer or window (or any of their prefixes),
the scope are hierarchical, meaning that a Window calling a hook will
@@ -748,6 +748,15 @@ use the following command:
:hook global WinCreate .*\.cc %{ addhl number_lines }
-----------------------------------------------------
+if <group> is given, make this hook part of the named group. groups
+are used for removing hooks with the +rmhooks+ command
+
+-----------------------
+rmhooks <scope> <group>
+-----------------------
+
+will remove every hooks in <scope> that are part of the given group.
+
existing hooks are:
* +NormalIdle+: A certain duration has passed since last key was pressed in