Mercurial > irccd
annotate man/irccd-api-hook.3 @ 1089:16e66403ea66
plugins: substitute IRCCD_VERSION in Javascript plugins
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 21 Jul 2021 15:33:17 +0200 |
parents | ec5461750efd |
children | f06e9761cc90 |
rev | line source |
---|---|
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 .\" |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 .\" Copyright (c) 2013-2021 David Demelier <markand@malikania.fr> |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 .\" |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 .\" copyright notice and this permission notice appear in all copies. |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 .\" |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 .\" |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 .Dd @IRCCD_MAN_DATE@ |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 .Dt IRCCD-API-HOOK 3 |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 .Os |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 .\" NAME |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 .Sh NAME |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 .Nm Irccd.Hook |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Nd irccd hook API |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 .\" SYNOPSIS |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 .Sh SYNOPSIS |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 .Fn Irccd.Hook.add "name, path" |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 .Fn Irccd.Hook.list |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 .Fn irccd.Hook.remove "name" |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 .\" DESCRIPTION |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 .Sh DESCRIPTION |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 Add, remove and list hooks. |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 .\" METHODS |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 .Sh METHODS |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 .\" Irccd.Hook.add |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 The |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 .Fn Irccd.Hook.add |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 method adds the rule specified by |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 .Fa path |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 with the identifier |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 .Fa name . |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 The API does not check the presence of the hook file and therefore can be used |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 before the hook actually exists on the filesystem. |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 .Pp |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 .\" Irccd.Hook.list |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 The |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 .Fn Irccd.Hook.list |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 method return an array of object for all hooks loaded. Each entry consists of |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 two properties: |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 .Fa name |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 and |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 .Fa path |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 which denotes the hook's name and its filesystem path respectively. |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 .Pp |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 .\" Irccd.Hook.remove |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 The |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 .Fn Irccd.Hook.remove |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 method removes the hook specified by |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 .Fa name . |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 .\" EXCEPTIONS |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 .Sh EXCEPTIONS |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 .Bl -tag -width Er |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 .It Bq Er Error |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 Thrown from |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 .Fn Irccd.Hook.add |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 if a hook with |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 .Fa name |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 already exists. |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 .El |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 .\" SEE ALSO |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 .Sh SEE ALSO |
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 .Xr irccd-api 3 |