]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/man/man3/commands.h.3
7f72427e75b4fff87482f0e4aee13cb37278ec71
[user/henk/code/inspircd.git] / docs / man / man3 / commands.h.3
1 .TH "commands.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 commands.h \- 
6 .SH SYNOPSIS
7 .br
8 .PP
9 \fC#include <typeinfo>\fP
10 .br
11 \fC#include <iostream>\fP
12 .br
13 \fC#include <string>\fP
14 .br
15 \fC#include <deque>\fP
16 .br
17 \fC#include <sstream>\fP
18 .br
19 \fC#include <vector>\fP
20 .br
21 \fC#include 'users.h'\fP
22 .br
23 \fC#include 'channels.h'\fP
24 .br
25
26 .SS "Functions"
27
28 .in +1c
29 .ti -1c
30 .RI "void \fBhandle_join\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
31 .br
32 .RI "\fIThese are the handlers for user commands. \fP"
33 .ti -1c
34 .RI "void \fBhandle_part\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
35 .br
36 .ti -1c
37 .RI "void \fBhandle_kick\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
38 .br
39 .ti -1c
40 .RI "void \fBhandle_die\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
41 .br
42 .ti -1c
43 .RI "void \fBhandle_restart\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
44 .br
45 .ti -1c
46 .RI "void \fBhandle_kill\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
47 .br
48 .ti -1c
49 .RI "void \fBhandle_summon\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
50 .br
51 .ti -1c
52 .RI "void \fBhandle_users\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
53 .br
54 .ti -1c
55 .RI "void \fBhandle_pass\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
56 .br
57 .ti -1c
58 .RI "void \fBhandle_invite\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
59 .br
60 .ti -1c
61 .RI "void \fBhandle_topic\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
62 .br
63 .ti -1c
64 .RI "void \fBhandle_names\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
65 .br
66 .ti -1c
67 .RI "void \fBhandle_privmsg\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
68 .br
69 .ti -1c
70 .RI "void \fBhandle_notice\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
71 .br
72 .ti -1c
73 .RI "void \fBhandle_info\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
74 .br
75 .ti -1c
76 .RI "void \fBhandle_time\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
77 .br
78 .ti -1c
79 .RI "void \fBhandle_whois\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
80 .br
81 .ti -1c
82 .RI "void \fBhandle_quit\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
83 .br
84 .ti -1c
85 .RI "void \fBhandle_who\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
86 .br
87 .ti -1c
88 .RI "void \fBhandle_wallops\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
89 .br
90 .ti -1c
91 .RI "void \fBhandle_list\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
92 .br
93 .ti -1c
94 .RI "void \fBhandle_rehash\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
95 .br
96 .ti -1c
97 .RI "void \fBhandle_lusers\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
98 .br
99 .ti -1c
100 .RI "void \fBhandle_admin\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
101 .br
102 .ti -1c
103 .RI "void \fBhandle_ping\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
104 .br
105 .ti -1c
106 .RI "void \fBhandle_pong\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
107 .br
108 .ti -1c
109 .RI "void \fBhandle_motd\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
110 .br
111 .ti -1c
112 .RI "void \fBhandle_rules\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
113 .br
114 .ti -1c
115 .RI "void \fBhandle_user\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
116 .br
117 .ti -1c
118 .RI "void \fBhandle_userhost\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
119 .br
120 .ti -1c
121 .RI "void \fBhandle_ison\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
122 .br
123 .ti -1c
124 .RI "void \fBhandle_away\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
125 .br
126 .ti -1c
127 .RI "void \fBhandle_whowas\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
128 .br
129 .ti -1c
130 .RI "void \fBhandle_trace\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
131 .br
132 .ti -1c
133 .RI "void \fBhandle_modules\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
134 .br
135 .ti -1c
136 .RI "void \fBhandle_stats\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
137 .br
138 .ti -1c
139 .RI "void \fBhandle_connect\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
140 .br
141 .ti -1c
142 .RI "void \fBhandle_squit\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
143 .br
144 .ti -1c
145 .RI "void \fBhandle_links\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
146 .br
147 .ti -1c
148 .RI "void \fBhandle_map\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
149 .br
150 .ti -1c
151 .RI "void \fBhandle_oper\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
152 .br
153 .ti -1c
154 .RI "void \fBhandle_nick\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
155 .br
156 .ti -1c
157 .RI "void \fBhandle_kline\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
158 .br
159 .ti -1c
160 .RI "void \fBhandle_gline\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
161 .br
162 .ti -1c
163 .RI "void \fBhandle_zline\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
164 .br
165 .ti -1c
166 .RI "void \fBhandle_qline\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
167 .br
168 .ti -1c
169 .RI "void \fBhandle_eline\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
170 .br
171 .ti -1c
172 .RI "void \fBhandle_server\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
173 .br
174 .ti -1c
175 .RI "void \fBhandle_loadmodule\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
176 .br
177 .ti -1c
178 .RI "void \fBhandle_unloadmodule\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
179 .br
180 .ti -1c
181 .RI "void \fBhandle_link_packet\fP (char *udp_msg, char *tcp_host, \fBserverrec\fP *serv)"
182 .br
183 .RI "\fISpecial functions for processing server to server traffic. \fP"
184 .ti -1c
185 .RI "void \fBprocess_restricted_commands\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *ipaddr, int port)"
186 .br
187 .ti -1c
188 .RI "void \fBhandle_amp\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
189 .br
190 .RI "\fIThese are the handlers for server commands (tokens). \fP"
191 .ti -1c
192 .RI "void \fBhandle_dollar\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
193 .br
194 .ti -1c
195 .RI "void \fBhandle_J\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
196 .br
197 .ti -1c
198 .RI "void \fBhandle_R\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
199 .br
200 .ti -1c
201 .RI "void \fBhandle_plus\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
202 .br
203 .ti -1c
204 .RI "void \fBhandle_b\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
205 .br
206 .ti -1c
207 .RI "void \fBhandle_a\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
208 .br
209 .ti -1c
210 .RI "void \fBhandle_F\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
211 .br
212 .ti -1c
213 .RI "void \fBhandle_N\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
214 .br
215 .ti -1c
216 .RI "void \fBhandle_AT\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
217 .br
218 .ti -1c
219 .RI "void \fBhandle_k\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
220 .br
221 .ti -1c
222 .RI "void \fBhandle_n\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
223 .br
224 .ti -1c
225 .RI "void \fBhandle_Q\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
226 .br
227 .ti -1c
228 .RI "void \fBhandle_K\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
229 .br
230 .ti -1c
231 .RI "void \fBhandle_L\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
232 .br
233 .ti -1c
234 .RI "void \fBhandle_m\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
235 .br
236 .ti -1c
237 .RI "void \fBhandle_M\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
238 .br
239 .ti -1c
240 .RI "void \fBhandle_T\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
241 .br
242 .ti -1c
243 .RI "void \fBhandle_t\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
244 .br
245 .ti -1c
246 .RI "void \fBhandle_i\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
247 .br
248 .ti -1c
249 .RI "void \fBhandle_P\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
250 .br
251 .ti -1c
252 .RI "void \fBhandle_V\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)"
253 .br
254 .ti -1c
255 .RI "bool \fBis_uline\fP (const char *server)"
256 .br
257 .RI "\fIFunctions for u:lined servers. \fP"
258 .ti -1c
259 .RI "long \fBduration\fP (const char *str)"
260 .br
261 .RI "\fIOther useful functions. \fP"
262 .in -1c
263 .SH "Function Documentation"
264 .PP 
265 .SS "long duration (const char * str)"
266 .PP
267 Other useful functions. Referenced by Server::AddELine(), Server::AddGLine(), Server::AddKLine(), Server::AddQLine(), Server::AddZLine(), and Server::CalcDuration().
268 .SS "void handle_a (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
269 .PP
270 .SS "void handle_admin (char ** parameters, int pcnt, \fBuserrec\fP * user)"
271 .PP
272 .SS "void handle_amp (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
273 .PP
274 These are the handlers for server commands (tokens). 
275 .SS "void handle_AT (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
276 .PP
277 .SS "void handle_away (char ** parameters, int pcnt, \fBuserrec\fP * user)"
278 .PP
279 .SS "void handle_b (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
280 .PP
281 .SS "void handle_connect (char ** parameters, int pcnt, \fBuserrec\fP * user)"
282 .PP
283 .SS "void handle_die (char ** parameters, int pcnt, \fBuserrec\fP * user)"
284 .PP
285 .SS "void handle_dollar (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
286 .PP
287 .SS "void handle_eline (char ** parameters, int pcnt, \fBuserrec\fP * user)"
288 .PP
289 .SS "void handle_F (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
290 .PP
291 .SS "void handle_gline (char ** parameters, int pcnt, \fBuserrec\fP * user)"
292 .PP
293 .SS "void handle_i (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
294 .PP
295 .SS "void handle_info (char ** parameters, int pcnt, \fBuserrec\fP * user)"
296 .PP
297 .SS "void handle_invite (char ** parameters, int pcnt, \fBuserrec\fP * user)"
298 .PP
299 .SS "void handle_ison (char ** parameters, int pcnt, \fBuserrec\fP * user)"
300 .PP
301 .SS "void handle_J (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
302 .PP
303 .SS "void handle_join (char ** parameters, int pcnt, \fBuserrec\fP * user)"
304 .PP
305 These are the handlers for user commands. 
306 .SS "void handle_K (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
307 .PP
308 .SS "void handle_k (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
309 .PP
310 .SS "void handle_kick (char ** parameters, int pcnt, \fBuserrec\fP * user)"
311 .PP
312 .SS "void handle_kill (char ** parameters, int pcnt, \fBuserrec\fP * user)"
313 .PP
314 .SS "void handle_kline (char ** parameters, int pcnt, \fBuserrec\fP * user)"
315 .PP
316 .SS "void handle_L (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
317 .PP
318 .SS "void handle_link_packet (char * udp_msg, char * tcp_host, \fBserverrec\fP * serv)"
319 .PP
320 Special functions for processing server to server traffic. 
321 .SS "void handle_links (char ** parameters, int pcnt, \fBuserrec\fP * user)"
322 .PP
323 .SS "void handle_list (char ** parameters, int pcnt, \fBuserrec\fP * user)"
324 .PP
325 .SS "void handle_loadmodule (char ** parameters, int pcnt, \fBuserrec\fP * user)"
326 .PP
327 .SS "void handle_lusers (char ** parameters, int pcnt, \fBuserrec\fP * user)"
328 .PP
329 .SS "void handle_M (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
330 .PP
331 .SS "void handle_m (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
332 .PP
333 .SS "void handle_map (char ** parameters, int pcnt, \fBuserrec\fP * user)"
334 .PP
335 .SS "void handle_modules (char ** parameters, int pcnt, \fBuserrec\fP * user)"
336 .PP
337 .SS "void handle_motd (char ** parameters, int pcnt, \fBuserrec\fP * user)"
338 .PP
339 .SS "void handle_n (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
340 .PP
341 .SS "void handle_N (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
342 .PP
343 .SS "void handle_names (char ** parameters, int pcnt, \fBuserrec\fP * user)"
344 .PP
345 .SS "void handle_nick (char ** parameters, int pcnt, \fBuserrec\fP * user)"
346 .PP
347 .SS "void handle_notice (char ** parameters, int pcnt, \fBuserrec\fP * user)"
348 .PP
349 .SS "void handle_oper (char ** parameters, int pcnt, \fBuserrec\fP * user)"
350 .PP
351 .SS "void handle_P (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
352 .PP
353 .SS "void handle_part (char ** parameters, int pcnt, \fBuserrec\fP * user)"
354 .PP
355 .SS "void handle_pass (char ** parameters, int pcnt, \fBuserrec\fP * user)"
356 .PP
357 .SS "void handle_ping (char ** parameters, int pcnt, \fBuserrec\fP * user)"
358 .PP
359 .SS "void handle_plus (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
360 .PP
361 .SS "void handle_pong (char ** parameters, int pcnt, \fBuserrec\fP * user)"
362 .PP
363 .SS "void handle_privmsg (char ** parameters, int pcnt, \fBuserrec\fP * user)"
364 .PP
365 .SS "void handle_Q (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
366 .PP
367 .SS "void handle_qline (char ** parameters, int pcnt, \fBuserrec\fP * user)"
368 .PP
369 .SS "void handle_quit (char ** parameters, int pcnt, \fBuserrec\fP * user)"
370 .PP
371 .SS "void handle_R (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
372 .PP
373 .SS "void handle_rehash (char ** parameters, int pcnt, \fBuserrec\fP * user)"
374 .PP
375 .SS "void handle_restart (char ** parameters, int pcnt, \fBuserrec\fP * user)"
376 .PP
377 .SS "void handle_rules (char ** parameters, int pcnt, \fBuserrec\fP * user)"
378 .PP
379 .SS "void handle_server (char ** parameters, int pcnt, \fBuserrec\fP * user)"
380 .PP
381 .SS "void handle_squit (char ** parameters, int pcnt, \fBuserrec\fP * user)"
382 .PP
383 .SS "void handle_stats (char ** parameters, int pcnt, \fBuserrec\fP * user)"
384 .PP
385 .SS "void handle_summon (char ** parameters, int pcnt, \fBuserrec\fP * user)"
386 .PP
387 .SS "void handle_t (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
388 .PP
389 .SS "void handle_T (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
390 .PP
391 .SS "void handle_time (char ** parameters, int pcnt, \fBuserrec\fP * user)"
392 .PP
393 .SS "void handle_topic (char ** parameters, int pcnt, \fBuserrec\fP * user)"
394 .PP
395 .SS "void handle_trace (char ** parameters, int pcnt, \fBuserrec\fP * user)"
396 .PP
397 .SS "void handle_unloadmodule (char ** parameters, int pcnt, \fBuserrec\fP * user)"
398 .PP
399 .SS "void handle_user (char ** parameters, int pcnt, \fBuserrec\fP * user)"
400 .PP
401 .SS "void handle_userhost (char ** parameters, int pcnt, \fBuserrec\fP * user)"
402 .PP
403 .SS "void handle_users (char ** parameters, int pcnt, \fBuserrec\fP * user)"
404 .PP
405 .SS "void handle_V (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)"
406 .PP
407 .SS "void handle_wallops (char ** parameters, int pcnt, \fBuserrec\fP * user)"
408 .PP
409 .SS "void handle_who (char ** parameters, int pcnt, \fBuserrec\fP * user)"
410 .PP
411 .SS "void handle_whois (char ** parameters, int pcnt, \fBuserrec\fP * user)"
412 .PP
413 .SS "void handle_whowas (char ** parameters, int pcnt, \fBuserrec\fP * user)"
414 .PP
415 .SS "void handle_zline (char ** parameters, int pcnt, \fBuserrec\fP * user)"
416 .PP
417 .SS "bool is_uline (const char * server)"
418 .PP
419 Functions for u:lined servers. Referenced by Server::IsUlined().
420 .SS "void process_restricted_commands (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * ipaddr, int port)"
421 .PP
422 .SH "Author"
423 .PP 
424 Generated automatically by Doxygen for InspIRCd from the source code.