Mercurial > irccd
annotate man/irccd-ipc.7 @ 1130:1b018226963f
misc: add 1.y.z info in CHANGES.md
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 09 Dec 2021 10:31:54 +0100 |
parents | 509bcfb14670 |
children | f06e9761cc90 |
rev | line source |
---|---|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 .\" |
1018
cf99df45cb84
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
2 .\" Copyright (c) 2013-2021 David Demelier <markand@malikania.fr> |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 .\" copyright notice and this permission notice appear in all copies. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 .Dd @IRCCD_MAN_DATE@ |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
17 .Dt IRCCD-IPC 7 |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 .Os |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 .\" NAME |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 .Sh NAME |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
21 .Nm irccd-ipc |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Nd irccd network protocol |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
23 .\" SYNOPSIS |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
24 .Sh SYNOPSIS |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
25 .Nm HOOK-ADD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
26 .Ar name Ar path |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
27 .Nm HOOK-LIST |
1030
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
28 .Nm HOOK-REMOVE |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
29 .Ar name |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
30 .Nm PLUGIN-CONFIG |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
31 .Ar name Op Ar variable Op Ar value |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
32 .Nm PLUGIN-INFO |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
33 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
34 .Nm PLUGIN-LOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
35 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
36 .Nm PLUGIN-PATH |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
37 .Ar name Op Ar variable Op Ar value |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
38 .Nm PLUGIN-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
39 .Nm PLUGIN-RELOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
40 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
41 .Nm PLUGIN-TEMPLATE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
42 .Ar name Op Ar variable Op Ar value |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
43 .Nm PLUGIN-UNLOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
44 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
45 .Nm RULE-ADD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
46 .Ar accept|drop |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
47 .Op ceiops=value |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
48 .Nm RULE-EDIT |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
49 .Ar index |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
50 .Op ceops(+|-)value |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
51 .Op a=accept|drop |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
52 .Nm RULE-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
53 .Nm RULE-MOVE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
54 .Ar from |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
55 .Ar to |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
56 .Nm RULE-REMOVE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
57 .Ar index |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
58 .Nm SERVER-DISCONNECT |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
59 .Op name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
60 .Nm SERVER-MESSAGE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
61 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
62 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
63 .Ar message |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
64 .Nm SERVER-ME |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
65 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
66 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
67 .Ar message |
1030
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
68 .Nm SERVER-MODE |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
69 .Ar name |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
70 .Ar channel |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
71 .Ar mode |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
72 .Op Ar args |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
73 .Nm SERVER-NOTICE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
74 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
75 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
76 .Ar notice |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
77 .Nm SERVER-INFO |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
78 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
79 .Nm SERVER-INVITE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
80 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
81 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
82 .Ar target |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
83 .Nm SERVER-JOIN |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
84 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
85 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
86 .Op Ar password |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
87 .Nm SERVER-KICK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
88 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
89 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
90 .Ar target |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
91 .Op Ar reason |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
92 .Nm SERVER-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
93 .Nm SERVER-PART |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
94 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
95 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
96 .Op Ar reason |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
97 .Nm SERVER-TOPIC |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
98 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
99 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
100 .Ar topic |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
101 .Nm WATCH |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
102 .\" DESCRIPTION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
103 .Sh DESCRIPTION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
104 This guide will help you controlling irccd via sockets. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
105 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
106 For this to work, you need to define a transport in your |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
107 .Pa irccd.conf |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
108 file, for more information see |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
109 .Xr irccd.conf 5 . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
110 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
111 Most of the commands are similar to |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
112 .Nm irccdctl |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
113 and mapped to the same network command. For more detailed information about each |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
114 command, take a look at |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
115 .Xr irccdctl 1 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
116 before. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
117 .\" SYNTAX |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
118 .Sh SYNTAX |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
119 The irccd program uses plain text for networking messages that consist of a |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
120 command name, its arguments and ends with a CRLF delimiter. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
121 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
122 Example of command: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
123 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
124 SERVER-MESSAGE malikania #test Hello world! |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
125 .Ed |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
126 .\" RESPONSES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
127 .Sh RESPONSES |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
128 All command emit a response even though if they don't produce output. If a |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
129 command succeeds, a plain |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
130 .Dq OK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
131 is returned, otherwise |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
132 .Dq ERROR |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
133 followed by a message is sent instead. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
134 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
135 Example with a successful message: |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
136 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
137 OK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
138 .Ed |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
139 .Pp |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
140 Example of error: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
141 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
142 ERROR server not found |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
143 .Ed |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
144 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
145 Some command may produce more output that are printed under several lines for an |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
146 easier interpretation client side. In that case commands usually return |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
147 .Dq OK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
148 followed by the number of lines provided. |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
149 .Pp |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
150 Example with |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
151 .Ar PLUGIN-CONFIG : |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
152 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
153 OK 2 |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
154 collaborative=true |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
155 level=hard |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
156 .Ed |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
157 .Sh COMMANDS |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
158 .\" COMMANDS |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
159 The following commands are available. |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
160 .Bl -tag -width "SERVER-DISCONNECT" |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
161 .\" HOOK-ADD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
162 .It Cm HOOK-ADD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
163 Add the hook |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
164 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
165 at the given |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
166 .Ar path . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
167 .\" HOOK-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
168 .It Cm HOOK-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
169 Returns the list of hooks by their names separated by a space immediately after |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
170 .Dq OK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
171 status. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
172 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
173 Example: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
174 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
175 OK irc-notify mail-notify |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
176 .Ed |
1030
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
177 .\" HOOK-REMOVE |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
178 .It Cm HOOK-REMOVE |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
179 Removes the hook specified by |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
180 .Ar name . |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
181 .\" PLUGIN-CONFIG |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
182 .It Cm PLUGIN-CONFIG |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
183 Set or get |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
184 .Ar variable |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
185 and its |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
186 .Ar value |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
187 if specified for the plugin |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
188 .Ar name . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
189 Returns the list of configuration variables if there were only the plugin |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
190 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
191 or return only the value if |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
192 .Ar variable |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
193 was specified. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
194 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
195 Example if |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
196 .Ar variable |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
197 was specified: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
198 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
199 OK 1 |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
200 current value |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
201 .Ed |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
202 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
203 Example if |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
204 .Ar variable |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
205 was not specified: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
206 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
207 OK 2 |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
208 collaborative=true |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
209 level=hard |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
210 .Ed |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
211 .\" PLUGIN-INFO |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
212 .It Cm PLUGIN-INFO |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
213 Return the information about the plugin |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
214 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
215 in the form: |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
216 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
217 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
218 OK 5 |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
219 name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
220 long description |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
221 version |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
222 license |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
223 author |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
224 .Ed |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
225 .\" PLUGIN-LOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
226 .It Cm PLUGIN-LOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
227 Find and load the plugin specified by |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
228 .Ar name . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
229 .\" PLUGIN-PATH |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
230 .It Cm PLUGIN-PATH |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
231 Exactly the same usage as |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
232 .Cm PLUGIN-CONFIG |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
233 but for the plugin paths. |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
234 .\" PLUGIN-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
235 .It Cm PLUGIN-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
236 Returns the list of plugins by their names separated by a space immediately |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
237 after |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
238 .Dq OK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
239 status. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
240 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
241 Example: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
242 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
243 OK ask auth hangman |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
244 .Ed |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
245 .\" PLUGIN-RELOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
246 .It Cm PLUGIN-RELOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
247 Reload the plugin specified by |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
248 .Ar name . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
249 .\" PLUGIN-TEMPLATE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
250 .It Cm PLUGIN-TEMPLATE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
251 Exactly the same usage as |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
252 .Cm PLUGIN-CONFIG |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
253 but for the plugin paths. |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
254 .\" PLUGIN-UNLOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
255 .It Cm PLUGIN-UNLOAD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
256 Unload and remove the plugin |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
257 .Ar name . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
258 .\" RULE-ADD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
259 .It Cm RULE-ADD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
260 Add a new rule with matching action to |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
261 .Ar accept |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
262 or |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
263 .Ar drop . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
264 Then by a list separated by spaces, add any key=value pair where the key |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
265 defines the criterion to set from |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
266 .Dq ceops |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
267 which adds a channel, event, origin, plugin or server respectively. The |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
268 .Ar i |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
269 character is the optional index where to insert the new rule. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
270 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
271 Example of client request: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
272 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
273 RULE-ADD accept c=#test s=example i=1 |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
274 .Ed |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
275 .\" RULE-EDIT |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
276 .It Cm RULE-EDIT |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
277 Edit the rule at the given |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
278 .Ar index . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
279 Similarly to |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
280 .Cm RULE-ADD |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
281 command, you can specify a criterion modification using the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
282 .Dq ceops |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
283 characters followed by a minus or plus string to either remove or add the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
284 criterion respectively. It is also possible to change the rule action with the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
285 key value pair |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
286 .Ar a=accept |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
287 Or |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
288 .Ar a=drop |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
289 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
290 Example of client request: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
291 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
292 RULE-EDIT c-#staff s+example a=drop |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
293 .Ed |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
294 .\" RULE-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
295 .It Cm RULE-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
296 Return the list of rules loaded in the form: |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
297 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
298 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
299 OK 1 |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
300 accept |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
301 list of servers |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
302 list of channels |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
303 list of origins |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
304 list of plugins |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
305 list of events |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
306 .Ed |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
307 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
308 For each rule, the block of 6 lines is repeated for every rule returned in the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
309 .Dq OK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
310 response. So if you have 4 rules, you'll have to read 24 lines total. |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
311 .\" RULE-MOVE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
312 .It Cm RULE-MOVE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
313 Move the rule at the position |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
314 .Ar from |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
315 to the position specified by |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
316 .Ar to . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
317 .\" RULE-REMOVE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
318 .It Cm RULE-REMOVE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
319 Remove the rule at the given |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
320 .Ar index . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
321 .\" SERVER-DISCONNECT |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
322 .It Cm SERVER-DISCONNECT |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
323 Disconnect and remove the server specified by |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
324 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
325 if specified otherwise, remove all. |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
326 .\" SERVER-MESSAGE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
327 .It Cm SERVER-MESSAGE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
328 Send the private |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
329 .Ar message |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
330 to the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
331 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
332 into the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
333 .Ar name . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
334 .\" SERVER-ME |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
335 .It Cm SERVER-ME |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
336 Send an action emote |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
337 .Ar message |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
338 to the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
339 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
340 into the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
341 .Ar name . |
1030
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
342 .\" SERVER-MODE |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
343 .It Cm SERVER-MODE |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
344 Change |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
345 .Ar channel |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
346 to the new |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
347 .Ar mode |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
348 with optional list of mode arguments specified by |
509bcfb14670
misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents:
1029
diff
changeset
|
349 .Ar args . |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
350 .\" SERVER-NOTICE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
351 .It Cm SERVER-NOTICE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
352 Send the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
353 .Ar notice |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
354 to the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
355 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
356 into the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
357 .Ar name . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
358 .\" SERVER-INFO |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
359 .It Cm SERVER-INFO |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
360 Get the information about the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
361 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
362 in the form: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
363 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
364 OK name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
365 hostname port [ssl] |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
366 nickname username real name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
367 #channels #channels... |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
368 .Ed |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
369 .\" SERVER-INVITE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
370 .It Cm SERVER-INVITE |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
371 Invite the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
372 .Ar target |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
373 to the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
374 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
375 into the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
376 .Ar name . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
377 .\" SERVER-JOIN |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
378 .It Cm SERVER-JOIN |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
379 Join a |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
380 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
381 into the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
382 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
383 using an optional |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
384 .Ar password . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
385 .\" SERVER-KICK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
386 .It Cm SERVER-KICK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
387 Kick the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
388 .Ar target |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
389 from the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
390 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
391 in the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
392 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
393 using an optional |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
394 .Ar reason . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
395 .\" SERVER-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
396 .It Cm SERVER-LIST |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
397 Returns the list of servers by their names separated by a space immediately |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
398 after |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
399 .Dq OK |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
400 status. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
401 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
402 Example: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
403 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
404 OK caramail wanadoo |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
405 .Ed |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
406 .\" SERVER-PART |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
407 .It Cm SERVER-PART |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
408 Leaves the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
409 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
410 from the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
411 .Ar name |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
412 using an optional |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
413 .Ar reason . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
414 .\" SERVER-TOPIC |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
415 .It Cm SERVER-TOPIC |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
416 Sets the new |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
417 .Ar topic |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
418 to the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
419 .Ar channel |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
420 into the server |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
421 .Ar name . |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
422 .\" WATCH |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
423 .It Cm WATCH |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
424 Enable watch mode. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
425 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
426 When set, irccd will notify the client about new IRC event incoming using the |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
427 syntax: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
428 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
429 EVENT-<NAME> arguments... |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
430 .Ed |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
431 .Pp |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
432 Example: |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
433 .Bd -literal -offset indent |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
434 EVENT-CONNECT wanadoo |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
435 EVENT-MESSAGE wanadoo jean!jean@caramail.com #games hello guys! |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
436 .Ed |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
437 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
438 .\" SEE ALSO |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
439 .Sh SEE ALSO |
1029
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
440 .Xr irccd 1 , |
113e523d999a
man: update some manual pages
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
441 .Xr irccdctl 1 |