Mercurial > irccd

diff man/irccd.conf.5 @ 895:f0d6bc79aa32

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
irccd: implement hooks, closes #2342 @2h The hook mechanism is an alternative approach to plugins which allow the user to write lightweight scripts in any language.
author David Demelier <markand@malikania.fr>
date Thu, 05 Sep 2019 13:39:32 +0200
parents 54496ac51649
children 32b0397f0992
line wrap: on
line diff
--- a/man/irccd.conf.5	Sun Sep 01 17:23:37 2019 +0200
+++ b/man/irccd.conf.5	Thu Sep 05 13:39:32 2019 +0200
@@ -208,6 +208,7 @@
 The section is redefinable per plugin basis using the
 .Va [paths.<plugin>]
 syntax.
+.\" [plugins]
 .Ss plugins
 This section is used to load plugins.
 .Pp
@@ -216,6 +217,10 @@
 path (including the .js extension).
 .Pp
 Warning: remember to add an empty string for searching plugins.
+.\" [hooks]
+.Ss hooks
+This sections stores every hooks in key-value pairs. The option key denotes the
+hook id and the value must be a path to the actual hook file.
 .\" [transport]
 .Ss transport
 This section defines transports that are used to communicate through clients
@@ -355,6 +360,11 @@
 channels = "#staff"
 plugins = "reboot"
 action = accept
+
+# Example of hooks
+# This create an hook named "mail" with the given path.
+[hooks]
+mail = "/path/to/mail.py"
 .Ed
 .\" SEE ALSO
 .Sh SEE ALSO