diff man/irccdctl.1 @ 895:f0d6bc79aa32

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 6c4fb8f42aca
children 32b0397f0992
line wrap: on
line diff
--- a/man/irccdctl.1	Sun Sep 01 17:23:37 2019 +0200
+++ b/man/irccdctl.1	Thu Sep 05 13:39:32 2019 +0200
@@ -22,8 +22,20 @@
 .Nd irccd controller agent
 .\" SYNOPSIS
 .Sh SYNOPSIS
+.\" hook-add
 .Nm
+.Cm hook-add
+.Ar id
+.Ar path
+.\" hook-list
+.Nm
+.Cm hook-list
+.\" hook-remove
+.Nm
+.Cm hook-remove
+.Ar id
 .\" plugin-config
+.Nm
 .Cm plugin-config
 .Ar id
 .Op Ar variable
@@ -223,6 +235,20 @@
 .\" COMMANDS
 .Sh COMMANDS
 .Bl -tag -width xxxxxxxx-yyyyyyyyy
+.\" hook-add
+.It Cm hook-add
+Add a new hook with
+.Ar id
+as unique identifier and
+.Ar path
+as local path (on the machine where irccd is running).
+.\" hook-list
+.It Cm hook-list
+List active hooks.
+.\" hook-remove
+.It Cm hook-remove
+Remove a hook with identifier
+.Ar id .
 .\" plugin-config
 .It Cm plugin-config
 Manipulate a configuration variable for the plugin specified by