Mercurial > irccd

annotate man/irccd-api-rule.3 @ 1126:722fcb2930ea

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man: add irccd-cmake(7) manual page
author David Demelier <markand@malikania.fr>
date Sun, 05 Dec 2021 11:30:55 +0100
parents ec5461750efd
children f06e9761cc90
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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-RULE 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.Rule
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd irccd rule 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 .Vt Irccd.Rule.Accept
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Vt Irccd.Rule.Drop
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .Fn Irccd.Rule.add "index, rule"
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Fn Irccd.Rule.clear
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .Fn Irccd.Rule.list
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .Fn Irccd.Rule.remove "index"
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .\" DESCRIPTION
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 .Sh DESCRIPTION
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 This module let you inspect, manage and/or create or delete rules.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 .Pp
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 Rules are created and obtained in JSON form with the following properties:
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 .Pp
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Bl -tag -compact -width "channels (array)"
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 .It Va action No (int)
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 Action to do for this rule. Must be either
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .Fa Irccd.Rule.Accept
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 or
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Fa Irccd.Rule.Drop .
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 .It Va servers No (array)
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 List of servers to match as array of strings targeting server identifiers.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 .It Va channels No (array)
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 List of channels to match
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 .It Va origins No (array)
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 List of origins (the full nickname and user hostname) to match.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .It Va events No (array)
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 List of events to match. See
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 .Xr irccd 1
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 manual page for available values.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .It Va plugins No (array)
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 List of plugins to match as array of string targeting plugin identifiers.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 .El
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .\" METHODS
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 .Sh METHODS
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .\" Irccd.Rule.add
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 The
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .Fn Irccd.Rule.add
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 method adds the new
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 .Ar rule
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 at the given
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 .Ar index
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 which can be null, in this case the rule is added to the end.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 .Pp
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .\" Irccd.Rule.clear
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 The
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .Fn Irccd.Rule.clear
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 method remove all rules.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .Pp
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .\" Irccd.Rule.list
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 The
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 .Fn Irccd.Rule.list
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 method returns all rules as an array of JSON description.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 .Pp
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 .\" Irccd.Rule.remove
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 The
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 .Fn Irccd.Rule.remove
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 function removes the rule at the given
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 .Ar index .
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 .\" EXCEPTIONS
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 .Sh EXCEPTIONS
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 .Bl -tag -width Er
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 .It Bq Er RangeError
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 Thrown in
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 .Fn Irccd.Rule.remove
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 if the
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 .Ar index
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 value was out of bounds.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 .It Bq Er TypeError
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 If the rule action was invalid.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 .El
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 .\" SEE ALSO
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 .Sh SEE ALSO
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 .Xr irccd-api 3