|
0
|
1 .\" |
|
|
2 .\" Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> |
|
|
3 .\" |
|
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
|
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
|
|
6 .\" copyright notice and this permission notice appear in all copies. |
|
|
7 .\" |
|
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
|
15 .\" |
|
|
16 .Dd @MONTH@ @DAY@, @YEAR@ |
|
|
17 .Dt IRCCDCTL 1 |
|
|
18 .Os |
|
|
19 .Sh NAME |
|
|
20 .Nm irccdctl |
|
|
21 .Nd irccd controller utility |
|
|
22 .\" SYNOPSIS |
|
|
23 .Sh SYNOPSIS |
|
|
24 This is the list of commands supported by |
|
|
25 .Ns Nm |
|
|
26 utility: |
|
|
27 .Pp |
|
|
28 .\" HELP |
|
|
29 .Nm |
|
|
30 .Cm help |
|
|
31 .Ar topic |
|
|
32 .\" WATCH |
|
|
33 .Nm |
|
|
34 .Cm watch |
|
|
35 .Op Ar options |
|
|
36 .Pp |
|
|
37 .\" PLUGIN-INFO |
|
|
38 .Nm |
|
|
39 .Cm plugin-info |
|
|
40 .Ar name |
|
|
41 .\" PLUGIN-list |
|
|
42 .Nm |
|
|
43 .Cm plugin-list |
|
|
44 .\" PLUGIN-LOAD |
|
|
45 .Nm |
|
|
46 .Cm plugin-load |
|
|
47 .Ar name |
|
|
48 .\" PLUGIN-RELOAD |
|
|
49 .Nm |
|
|
50 .Cm plugin-reload |
|
|
51 .Ar name |
|
|
52 .\" PLUGIN-UNLOAD |
|
|
53 .Nm |
|
|
54 .Cm plugin-unload |
|
|
55 .Ar name |
|
|
56 .Pp |
|
|
57 .\" SERVER-CMODE |
|
|
58 .Nm |
|
|
59 .Cm server-cmode |
|
|
60 .Ar server |
|
|
61 .Ar channel |
|
|
62 .Ar mode |
|
|
63 .\" SERVER-CNOTICE |
|
|
64 .Nm |
|
|
65 .Cm server-cnotice |
|
|
66 .Ar server |
|
|
67 .Ar channel |
|
|
68 .Ar message |
|
|
69 .\" SERVER-CONNECT |
|
|
70 .Nm |
|
|
71 .Cm server-connect |
|
|
72 .Op Ar options |
|
|
73 .Ar name |
|
|
74 .Ar host |
|
|
75 .Op Ar port |
|
|
76 .\" SERVER-DISCONNECT |
|
|
77 .Nm |
|
|
78 .Cm server-disconnect |
|
|
79 .Op Ar server |
|
|
80 .\" SERVER-INFO |
|
|
81 .Nm |
|
|
82 .Cm server-info |
|
|
83 .Ar server |
|
|
84 .\" SERVER-INVITE |
|
|
85 .Nm |
|
|
86 .Cm server-invite |
|
|
87 .Ar server |
|
|
88 .Ar target |
|
|
89 .Ar channel |
|
|
90 .\" SERVER-JOIN |
|
|
91 .Nm |
|
|
92 .Cm server-join |
|
|
93 .Ar server |
|
|
94 .Ar channel |
|
|
95 .Op Ar password |
|
|
96 .\" SERVER-KICK |
|
|
97 .Nm |
|
|
98 .Cm server-kick |
|
|
99 .Ar server |
|
|
100 .Ar nickname |
|
|
101 .Ar channel |
|
|
102 .Op Ar reason |
|
|
103 .\" SERVER-LIST |
|
|
104 .Nm |
|
|
105 .Cm server-list |
|
|
106 .\" SERVER-ME |
|
|
107 .Nm |
|
|
108 .Cm server-me |
|
|
109 .Ar server |
|
|
110 .Ar target |
|
|
111 .Ar message |
|
|
112 .\" SERVER-MESSAGE |
|
|
113 .Nm |
|
|
114 .Cm server-message |
|
|
115 .Ar server |
|
|
116 .Ar target |
|
|
117 .Ar message |
|
|
118 .\" SERVER-MODE |
|
|
119 .Nm |
|
|
120 .Cm server-mode |
|
|
121 .Ar server |
|
|
122 .Ar mode |
|
|
123 .\" SERVER-NICK |
|
|
124 .Nm |
|
|
125 .Cm server-nick |
|
|
126 .Ar server |
|
|
127 .Ar newnickname |
|
|
128 .\" SERVER-NOTICE |
|
|
129 .Nm |
|
|
130 .Cm server-notice |
|
|
131 .Ar server |
|
|
132 .Ar nickname |
|
|
133 .Ar message |
|
|
134 .\" SERVER-PART |
|
|
135 .Nm |
|
|
136 .Cm server-part |
|
|
137 .Ar server |
|
|
138 .Ar channel |
|
|
139 .\" SERVER-RECONNECT |
|
|
140 .Nm |
|
|
141 .Cm server-reconnect |
|
|
142 .Op Ar name |
|
|
143 .\" SERVER-TOPIC |
|
|
144 .Nm |
|
|
145 .Cm server-topic |
|
|
146 .Ar server |
|
|
147 .Ar channel |
|
|
148 .Ar topic |
|
|
149 .\" DESCRIPTION |
|
|
150 .Sh DESCRIPTION |
|
|
151 The |
|
|
152 .Nm irccdctl |
|
|
153 utility provides serveral options to manipulate a running |
|
|
154 irccd instance. |
|
|
155 .Pp |
|
|
156 It uses sockets to do a basic IPC messaging with irccd, you can use unix |
|
|
157 or internet domain sockets. |
|
|
158 .Pp |
|
|
159 The following options are available: |
|
|
160 .Bl -tag -width indent |
|
|
161 .It Fl c Ar config |
|
|
162 A path to a config file. |
|
|
163 .It Fl t, Fl -type Ar domain |
|
|
164 The domain to use, specify internet or unix. |
|
|
165 .It Fl v |
|
|
166 Be more verbose. |
|
|
167 .El |
|
|
168 .\" INTERNET OPTIONS |
|
|
169 .Pp |
|
|
170 The following options are available for |
|
|
171 .Fl t Ar ip, ipv6 : |
|
|
172 .Bl -tag -width indent |
|
|
173 .It Fl h, Fl -host |
|
|
174 The hostname to connect. |
|
|
175 .It Fl p, Fl -port |
|
|
176 The port to use. |
|
|
177 .El |
|
|
178 .\" UNIX OPTIONS |
|
|
179 .Pp |
|
|
180 The following options are available for |
|
|
181 .Fl t Ar unix : |
|
|
182 .Bl -tag -width indent |
|
|
183 .It Fl P, Fl -part Ar path |
|
|
184 The path to the unix socket. |
|
|
185 .El |
|
|
186 .\" EXAMPLES |
|
|
187 .Sh EXAMPLES |
|
|
188 .Bl -tag -width 0n |
|
|
189 .It Sy Example 1 Show help |
|
|
190 .Bd -literal -offset 2n |
|
|
191 $ irccdctl help server-message |
|
|
192 .Ed |
|
|
193 .El |
|
|
194 .Bl -tag -width 0n |
|
|
195 .It Sy Example 2 Sending a message |
|
|
196 .Pp |
|
|
197 .Bd -literal -offset 2n |
|
|
198 $ irccdctl server-message localhost #staff "Hello World" |
|
|
199 .Ed |
|
|
200 .It Sy Example 3 Connect to a Unix socket to join a channel |
|
|
201 .Pp |
|
|
202 .Bd -literal -offset 2n |
|
|
203 $ irccdctl -t unix -P /tmp/foo.sock server-join localhost #foo |
|
|
204 .Ed |
|
|
205 .El |
|
|
206 .\" SEE ALSO |
|
|
207 .Sh SEE ALSO |
|
|
208 .Xr irccd 1 , |
|
|
209 .Xr irccdctl.conf 5 |
|
|
210 .\" BUGS |
|
|
211 .Sh BUGS |
|
|
212 Be careful when using channel names, some shells (i.e bash) ignore the # |
|
|
213 character. In that case, quote the command like this: |
|
|
214 .Bd -literal -offset 2n |
|
|
215 $ irccdctl join localhost "#bar" |
|
|
216 .Ed |
|
|
217 .\" AUTHORS |
|
|
218 .Sh AUTHORS |
|
|
219 irccdctl was written by David Demelier <markand@malikania.fr> |
