]> jfr.im git - irc/rqf/shadowircd.git/blob - doc/sgml/oper-guide/commands.sgml
9209ada78e2d8d3ffe39b7a8731b50a401e12af3
[irc/rqf/shadowircd.git] / doc / sgml / oper-guide / commands.sgml
1 <chapter id="commands">
2 <title>Operator Commands</title>
3 <sect1>
4 <title>Network management commands</title>
5 <note>
6 <para>
7 Except STATS letters, all commands and names are case insensitive.
8 </para>
9 </note>
10 <sect2>
11 <title>CONNECT</title>
12 <cmdsynopsis><command>CONNECT</command>
13 <arg choice=plain><replaceable>target</replaceable></arg>
14 <arg><replaceable>port</replaceable></arg>
15 <arg><replaceable>source</replaceable></arg>
16 </cmdsynopsis>
17 <para>
18 Initiate a connection attempt to server <replaceable class=parameter>target</replaceable>. If a port is
19 given, connect to that port on the target, otherwise use the one given in <filename>ircd.conf</filename>. If
20 <replaceable class=parameter>source</replaceable> is given, tell that server to initiate the connection
21 attempt, otherwise it will be made from the server you are attached to.
22 </para>
23 </sect2>
24 <sect2>
25 <title>SQUIT</title>
26 <cmdsynopsis>
27 <command>SQUIT</command>
28 <arg choice=plain><replaceable>server</replaceable></arg>
29 <arg><replaceable>reason</replaceable></arg>
30 </cmdsynopsis>
31 <para>
32 Closes down the link to <replaceable>server</replaceable> from this side of the network. If a reason is
33 given, it will be sent out in the server notices on both sides of the link.
34 </para>
35 </sect2>
36 <sect2>
37 <title>REHASH</title>
38 <cmdsynopsis>
39 <command>REHASH</command>
40 <group>
41 <arg>BANS</arg>
42 <arg>DNS</arg>
43 <arg>MOTD</arg>
44 <arg>OMOTD</arg>
45 <arg>GLINES</arg>
46 <arg>PGLINES</arg>
47 <arg>TKLINES</arg>
48 <arg>TDLINES</arg>
49 <arg>TXLINES</arg>
50 <arg>TRESVS</arg>
51 <arg>REJECTCACHE</arg>
52 <arg>HELP</arg>
53 </group>
54 <arg><replaceable>server</replaceable></arg>
55 </cmdsynopsis>
56 <para>
57 With no parameter given, <filename>ircd.conf</filename> will be reread and parsed.
58 The server argument is a wildcard match of server names.
59 </para>
60 <variablelist>
61 <title>Parameters</title>
62 <varlistentry>
63 <term>BANS</term>
64 <listitem>
65 <para>Rereads <filename>kline.conf</filename>, <filename>dline.conf</filename>, <filename>xline.conf</filename>, <filename>resv.conf</filename> and their .perm variants</para>
66 </listitem>
67 </varlistentry>
68 <varlistentry>
69 <term>DNS</term>
70 <listitem>
71 <para>Reread <filename>/etc/resolv.conf</filename>.</para>
72 </listitem>
73 </varlistentry>
74 <varlistentry>
75 <term>MOTD</term>
76 <listitem>
77 <para>Reload the MOTD file</para>
78 </listitem>
79 </varlistentry>
80 <varlistentry>
81 <term>OMOTD</term>
82 <listitem>
83 <para>Reload the operator MOTD file</para>
84 </listitem>
85 </varlistentry>
86 <varlistentry>
87 <term>GLINES</term>
88 <listitem>
89 <para>Clears G:lines.</para>
90 </listitem>
91 </varlistentry>
92 <varlistentry>
93 <term>PGLINES</term>
94 <listitem>
95 <para>Clears pending G:lines.</para>
96 </listitem>
97 </varlistentry>
98 <varlistentry>
99 <term>TKLINES</term>
100 <listitem>
101 <para>Clears temporary K:lines.</para>
102 </listitem>
103 </varlistentry>
104 <varlistentry>
105 <term>TDLINES</term>
106 <listitem>
107 <para>Clears temporary D:lines.</para>
108 </listitem>
109 </varlistentry>
110 <varlistentry>
111 <term>TXLINES</term>
112 <listitem>
113 <para>Clears temporary X:lines.</para>
114 </listitem>
115 </varlistentry>
116 <varlistentry>
117 <term>TRESVS</term>
118 <listitem>
119 <para>Clears temporary reservations.</para>
120 </listitem>
121 </varlistentry>
122 <varlistentry>
123 <term>REJECTCACHE</term>
124 <listitem>
125 <para>Clears the client rejection cache.</para>
126 </listitem>
127 </varlistentry>
128 <varlistentry>
129 <term>HELP</term>
130 <listitem>
131 <para>Refreshes the help system cache.</para>
132 </listitem>
133 </varlistentry>
134 </variablelist>
135 </sect2>
136 <sect2>
137 <title>RESTART</title>
138 <cmdsynopsis>
139 <command>RESTART</command>
140 <arg choice=plain><replaceable>server</replaceable></arg>
141 </cmdsynopsis>
142 <para>
143 Cause an immediate total shutdown of the IRC server, and restart from scratch as if it had just been executed.
144 </para>
145 <para>
146 This reexecutes the ircd using the compiled-in path, visible
147 as SPATH in INFO.
148 </para>
149 <note>
150 <para>This command cannot be used remotely. The server name is used only as a safety measure.</para>
151 </note>
152 </sect2>
153 <sect2>
154 <title>DIE</title>
155 <cmdsynopsis>
156 <command>DIE</command>
157 <arg choice=plain><replaceable>server</replaceable></arg>
158 </cmdsynopsis>
159 <para>Immediately terminate the IRC server, after sending notices to all connected clients and servers</para>
160 <note>
161 <para>This command cannot be used remotely. The server name is used only as a safety measure.</para>
162 </note>
163 </sect2>
164 <sect2>
165 <title>SET</title>
166 <cmdsynopsis>
167 <command>SET</command>
168 <group>
169 <arg>LOG</arg>
170 <arg>MAX</arg>
171 <arg>SPLITDELAY</arg>
172 <arg>SMALLNET</arg>
173 <arg>SPAMNUM</arg>
174 <arg>SPAMTIME</arg>
175 </group>
176 <arg choice=plain><replaceable>value</replaceable></arg>
177 </cmdsynopsis>
178 <para>The SET command sets a runtime-configurable value</para>
179 <variablelist>
180 <varlistentry>
181 <term>LOG</term>
182 <listitem>
183 <para>Logging level for ircd.log and syslog</para>
184 </listitem>
185 </varlistentry>
186 </variablelist>
187 <variablelist>
188 <varlistentry>
189 <term>MAX</term>
190 <listitem>
191 <para>Set the maximum connections allowed (may not exceed the compiled-in value HARD_FDLIMIT)</para>
192 </listitem>
193 </varlistentry>
194 <varlistentry>
195 <term>DRONETIME</term>
196 <listitem>
197 <para>Number of seconds in which DRONECOUNT messages must occur to trip the drone alarm</para>
198 </listitem>
199 </varlistentry>
200 <varlistentry>
201 <term>DRONECOUNT</term>
202 <listitem>
203 <para>Number of messages which constitutes a drone flood. 0 disables drone flood checking.</para>
204 </listitem>
205 </varlistentry>
206 <varlistentry>
207 <term>SPLITDELAY</term>
208 <listitem>
209 <para>Number of minutes after a connect burst begins until joining an empty channel will give you ops</para>
210 </listitem>
211 </varlistentry>
212 <varlistentry>
213 <term>SMALLNET</term>
214 <listitem>
215 <para>Sets the number of servers which are needed to constitute <quote>attached to the network</quote>, as opposed to <quote>split</quote></para>
216 </listitem>
217 </varlistentry>
218 <varlistentry>
219 <term>SPAMNUM</term>
220 <listitem>
221 <para>Sets the number of JOINs/PARTs which constitutes a possible spambot</para>
222 </listitem>
223 </varlistentry>
224 <varlistentry>
225 <term>SPAMTIME</term>
226 <listitem>
227 <para>Staying on a channel for less than this length of time adds to the SPAMNUM count</para>
228 </listitem>
229 </varlistentry>
230 </variablelist>
231 </sect2>
232 </sect1>
233 <sect1 id="usercommands">
234 <title>User management commands</title>
235 <sect2>
236 <title>KILL</title>
237 <cmdsynopsis>
238 <command>KILL</command>
239 <arg choice=plain><replaceable>nick</replaceable></arg>
240 <arg><replaceable>reason</replaceable></arg>
241 </cmdsynopsis>
242 <para>
243 Disconnects the user with the given nick from the server they are connected to,
244 with the reason given, if present, and broadcast a server notice announcing this.
245 </para>
246 <para>
247 Your nick and the reason will appear on channels.
248 </para>
249 </sect2>
250 <sect2>
251 <title>CLOSE</title>
252 <para>
253 Closes all connections from and to clients and servers who have not completed registering.
254 </para>
255 </sect2>
256 <sect2>
257 <title>KLINE</title>
258 <cmdsynopsis>
259 <command>KLINE</command>
260 <arg><replaceable>length</replaceable></arg>
261 <group>
262 <arg choice=plain><replaceable>user</replaceable>@<replaceable>host</replaceable></arg>
263 <arg choice=plain><replaceable>user</replaceable>@<replaceable>a</replaceable>.<replaceable>b</replaceable>.<replaceable>c</replaceable>.<replaceable>d</replaceable></arg>
264 </group>
265 <arg>ON <replaceable>servername</replaceable></arg>
266 <arg>:<replaceable>reason</replaceable></arg>
267 </cmdsynopsis>
268 <para>
269 Adds a K:line to <filename>kline.conf</filename> to ban the given user@host from using that
270 server.
271 </para>
272 <para>
273 If the optional parameter <replaceable>length</replaceable> is given, the K:line will
274 be temporary (i.e. it will not be stored on disk) and last that
275 long in minutes.
276 </para>
277 <para>
278 If an IP address is given, the ban will be against all hosts matching that IP regardless
279 of DNS. The IP address can be given as a full address (192.168.0.1), as a CIDR mask
280 (192.168.0.0/24), or as a glob (192.168.0.*).
281 </para>
282 <para>
283 All clients matching the K:line will be disconnected from the server immediately.
284 </para>
285 <para>
286 If a reason is specified, it will be sent to the client when they are disconnected, and
287 whenever a connection is attempted which is banned.
288 </para>
289 <para>
290 If the ON part is specified, the K:line is set on servers matching
291 the given mask (provided a matching shared{} block exists there).
292 Otherwise, if specified in a cluster{} block, the K:Line will be
293 propagated across the network accordingly.
294 </para>
295 </sect2>
296 <sect2>
297 <title>UNKLINE</title>
298 <cmdsynopsis>
299 <command>UNKLINE</command>
300 <arg choice=plain><replaceable>user</replaceable>@<replaceable>host</replaceable></arg>
301 <arg>ON <replaceable>servername</replaceable></arg>
302 </cmdsynopsis>
303 <para>
304 Will attempt to remove a K:line matching user@host from <filename>kline.conf</filename>, and will flush
305 a temporary K:line.
306 </para>
307 </sect2>
308 <sect2>
309 <title>XLINE</title>
310 <cmdsynopsis>
311 <command>XLINE</command>
312 <arg><replaceable>length</replaceable></arg>
313 <arg choice=plain><replaceable>mask</replaceable></arg>
314 <arg>ON <replaceable>servername</replaceable></arg>
315 <arg>:<replaceable>reason</replaceable></arg>
316 </cmdsynopsis>
317 <para>
318 Works similarly to KLINE, but matches against the real name field.
319 The wildcards are * (any sequence), ? (any character),
320 # (a digit) and @ (a letter); wildcard characters can be
321 escaped with a backslash.
322 </para>
323 <para>
324 Use \s for a space; this currently interferes with the
325 check whether the mask is already xlined and UNXLINE.
326 </para>
327 <para>
328 All clients matching the X:line will be disconnected from the server immediately.
329 </para>
330 <para>
331 The reason is never sent to users. Instead, they will be exited
332 with <quote>Bad user info</quote>.
333 </para>
334 <para>
335 If the ON part is specified, the X:line is set on servers matching
336 the given mask (provided a matching shared{} block exists there).
337 Otherwise, if specified in a cluster{} block, the X:line will be
338 propagated across the network accordingly.
339 </para>
340 </sect2>
341 <sect2>
342 <title>UNXLINE</title>
343 <cmdsynopsis>
344 <command>UNXLINE</command>
345 <arg choice=plain><replaceable>mask</replaceable></arg>
346 <arg>ON <replaceable>servername</replaceable></arg>
347 </cmdsynopsis>
348 <para>
349 Will attempt to remove an X:line from <filename>xline.conf</filename>, and will flush
350 a temporary X:line.
351 </para>
352 </sect2>
353 <sect2>
354 <title>RESV</title>
355 <cmdsynopsis>
356 <command>RESV</command>
357 <arg><replaceable>length</replaceable></arg>
358 <group>
359 <arg choice=plain><replaceable>channel</replaceable></arg>
360 <arg choice=plain><replaceable>mask</replaceable></arg>
361 </group>
362 <arg>ON <replaceable>servername</replaceable></arg>
363 <arg>:<replaceable>reason</replaceable></arg>
364 </cmdsynopsis>
365 <para>
366 If used on a channel, <quote>jupes</quote> the channel locally. Joins to the
367 channel will be disallowed and generate a server notice on +y, and
368 users will not be able to send to the channel. Channel jupes cannot
369 contain wildcards.
370 </para>
371 <para>
372 If used on a nickname mask, prevents local users from using a nick
373 matching the mask (the same wildcard characters as xlines). There
374 is no way to exempt the initial nick from this.
375 </para>
376 <para>
377 In neither case will current users of the nick or channel be
378 kicked or disconnected.
379 </para>
380 <para>
381 This facility is not designed to make certain nicks
382 or channels oper-only.
383 </para>
384 <para>
385 The reason is never sent to users.
386 </para>
387 <para>
388 If the ON part is specified, the resv is set on servers matching
389 the given mask (provided a matching shared{} block exists there).
390 Otherwise, if specified in a cluster{} block, the resv will be
391 propagated across the network accordingly.
392 </para>
393 </sect2>
394 <sect2>
395 <title>UNRESV</title>
396 <cmdsynopsis>
397 <command>UNRESV</command>
398 <group>
399 <arg choice=plain><replaceable>channel</replaceable></arg>
400 <arg choice=plain><replaceable>mask</replaceable></arg>
401 </group>
402 <arg>ON <replaceable>servername</replaceable></arg>
403 </cmdsynopsis>
404 <para>
405 Will attempt to remove a resv from <filename>resv.conf</filename>, and will flush
406 a temporary resv.
407 </para>
408 </sect2>
409 <sect2>
410 <title>DLINE</title>
411 <cmdsynopsis>
412 <command>DLINE</command>
413 <arg><replaceable>length</replaceable></arg>
414 <arg choice=plain><replaceable>a</replaceable>.<replaceable>b</replaceable>.<replaceable>c</replaceable>.<replaceable>d</replaceable></arg>
415 <arg>:<replaceable>reason</replaceable></arg>
416 </cmdsynopsis>
417 <para>
418 Adds a D:line to <filename>dline.conf</filename>, which will deny any connections
419 from the given IP address.
420 The IP address can be given as a full address (192.168.0.1) or
421 as a CIDR mask (192.168.0.0/24).
422 </para>
423 <para>
424 If the optional parameter <replaceable>length</replaceable> is given, the D:line will
425 be temporary (i.e. it will not be stored on disk) and last that
426 long in minutes.
427 </para>
428 <para>
429 All clients matching the D:line will be disconnected from the server immediately.
430 </para>
431 <para>
432 If a reason is specified, it will be sent to the client when they are disconnected, and,
433 if dline_reason is enabled,
434 whenever a connection is attempted which is banned.
435 </para>
436 <para>
437 D:lines are less load on a server, and may be more appropriate if somebody is flooding
438 connections.
439 </para>
440 <para>
441 D:lines cannot be set remotely on other servers.
442 </para>
443 <para>
444 Only exempt{} blocks exempt from D:lines.
445 Being a server or having kline_exempt in auth{} does
446 <emphasis>not</emphasis> exempt (different from K/G/X:lines).
447 </para>
448 </sect2>
449 <sect2>
450 <title>UNDLINE</title>
451 <cmdsynopsis>
452 <command>UNDLINE</command>
453 <arg choice=plain><replaceable>a.b.c.d</replaceable></arg>
454 </cmdsynopsis>
455 <para>
456 Will attempt to remove a D:line from <filename>dline.conf</filename>, and will flush
457 a temporary D:line.
458 </para>
459 </sect2>
460 <sect2>
461 <title>GLINE</title>
462 <cmdsynopsis>
463 <command>GLINE</command>
464 <group>
465 <arg choice=plain><replaceable>user</replaceable>@<replaceable>host</replaceable></arg>
466 <arg choice=plain><replaceable>user</replaceable>@<replaceable>a</replaceable>.<replaceable>b</replaceable>.<replaceable>c</replaceable>.<replaceable>d</replaceable></arg>
467 </group>
468 <arg choice=plain>:<replaceable>reason</replaceable></arg>
469 </cmdsynopsis>
470 <para>
471 Attempts to add a network-wide ban for the given mask.
472 It takes three different opers on three different servers
473 requesting the same G:line to have it triggered for a configured
474 time.
475 </para>
476 <para>
477 Once triggered, a G:line is similar to a temporary K:line on
478 each server. No further propagation or on-disk storage is done.
479 </para>
480 <note><para>
481 This command can be enabled or disabled in the configuration file.
482 If it is disabled, no oper on the server can issue a G:line and no
483 G:lined user is banned, but G:lines are still propagated to other
484 servers which may have G:lines enabled.
485 </para></note>
486 </sect2>
487 <sect2>
488 <title>UNGLINE</title>
489 <cmdsynopsis>
490 <command>UNGLINE</command>
491 <group>
492 <arg choice=plain><replaceable>user</replaceable>@<replaceable>host</replaceable></arg>
493 <arg choice=plain><replaceable>user</replaceable>@<replaceable>a</replaceable>.<replaceable>b</replaceable>.<replaceable>c</replaceable>.<replaceable>d</replaceable></arg>
494 </group>
495 </cmdsynopsis>
496 <para>
497 Removes the given G:line on this server.
498 </para>
499 </sect2>
500 <sect2>
501 <title>TESTGECOS</title>
502 <cmdsynopsis>
503 <command>TESTGECOS</command>
504 <arg choice=plain><replaceable>gecos</replaceable></arg>
505 </cmdsynopsis>
506 <para>
507 Looks up X:Lines matching the given gecos.
508 </para>
509 </sect2>
510 <sect2>
511 <title>TESTLINE</title>
512 <cmdsynopsis>
513 <command>TESTLINE</command>
514 <arg><replaceable>nick</replaceable>!</arg>
515 <group>
516 <arg choice=plain><replaceable>user</replaceable>@<replaceable>host</replaceable></arg>
517 <arg choice=plain><replaceable>a</replaceable>.<replaceable>b</replaceable>.<replaceable>c</replaceable>.<replaceable>d</replaceable></arg>
518 </group>
519 </cmdsynopsis>
520 <para>
521 Looks up the given hostmask or IP address and reports back on any auth{} blocks, D:, G:, or K: lines found.
522 If <replaceable>nick</replaceable> is given, also searches for
523 nick resvs.
524 </para>
525 <para>
526 For temporary items the number of minutes until the item expires
527 is shown (as opposed to the hit count in STATS q/Q/x/X).
528 </para>
529 <para>
530 This command will not perform DNS lookups; for best
531 results you must testline a host and its IP form.
532 </para>
533 <para>
534 The given username should begin with a tilde (~) if identd is not
535 in use. As of charybdis 2.1.1, no_tilde and username truncation will
536 be taken into account like in the normal client access check.
537 </para>
538 <para>
539 As of charybdis 2.2.0, a channel name can be specified and the
540 RESV will be returned, if there is one.
541 </para>
542 </sect2>
543 <sect2>
544 <title>TESTMASK</title>
545 <cmdsynopsis>
546 <command>TESTMASK</command>
547 <arg choice=plain><replaceable>hostmask</replaceable></arg>
548 <arg><replaceable>gecos</replaceable></arg>
549 </cmdsynopsis>
550 <para>
551 Searches the network for users that match the hostmask and gecos given,
552 returning the number of matching users on this server and other servers.
553 </para>
554 <para>
555 The <replaceable>hostmask</replaceable> is of the form user@host
556 or user@ip/cidr with * and ? wildcards, optionally preceded by
557 nick!.
558 </para>
559 <para>
560 The <replaceable>gecos</replaceable> field accepts the same wildcards
561 as xlines.
562 </para>
563 <para>
564 The IP address checked against is 255.255.255.255 if the IP address
565 is unknown (remote client on a TS5 server) or 0 if the IP address
566 is hidden (auth{} spoof).
567 </para>
568 </sect2>
569 <sect2>
570 <title>LUSERS</title>
571 <cmdsynopsis>
572 <command>LUSERS</command>
573 <arg><replaceable>mask</replaceable></arg>
574 <group>
575 <arg><replaceable>nick</replaceable></arg>
576 <arg><replaceable>server</replaceable></arg>
577 </group>
578 </cmdsynopsis>
579 <para>
580 Shows various user and channel counts.
581 </para>
582 <para>
583 The <replaceable>mask</replaceable> parameter is obsolete
584 but must be used when querying a remote server.
585 </para>
586 </sect2>
587 <sect2>
588 <title>TRACE</title>
589 <cmdsynopsis>
590 <command>TRACE</command>
591 <group>
592 <arg><replaceable>server</replaceable></arg>
593 <arg><replaceable>nick</replaceable></arg>
594 </group>
595 <arg><replaceable>location</replaceable></arg>
596 </cmdsynopsis>
597 <para>
598 With no argument or one argument which is the current server,
599 TRACE gives a list of all connections to the current server
600 and a summary of connection classes.
601 </para>
602 <para>
603 With one argument which is another server, TRACE displays the path
604 to the specified server, and all servers, opers and -i users
605 on that server, along with a summary of connection classes.
606 </para>
607 <para>
608 With one argument which is a client, TRACE displays the
609 path to that client, and that client's information.
610 </para>
611 <para>
612 If location is given, the command is executed on that server;
613 no path is displayed.
614 </para>
615 <para>
616 When listing connections, type, name and class is shown
617 in addition to information depending on the type:
618 </para>
619 <variablelist>
620 <title>TRACE types</title>
621 <varlistentry>
622 <term>Try.</term>
623 <listitem><para>
624 A server we are trying to make a TCP connection to.
625 </para></listitem>
626 </varlistentry>
627 <varlistentry>
628 <term>H.S.</term>
629 <listitem><para>
630 A server we have established a TCP connection to, but is not
631 yet registered.
632 </para></listitem>
633 </varlistentry>
634 <varlistentry>
635 <term>????</term>
636 <listitem><para>
637 An incoming connection that has not yet registered as
638 a user or a server (<quote>unknown</quote>).
639 Shows the username, hostname, IP address
640 and the time the connection has been open. It is possible
641 that the ident or DNS lookups have not completed yet, and in
642 any case no tildes are shown here.
643 Unknown connections may not have a name yet.
644 </para></listitem>
645 </varlistentry>
646 <varlistentry>
647 <term>User</term>
648 <listitem><para>
649 A registered unopered user.
650 Shows the username, hostname, IP address, the time the client
651 has not sent anything (as in STATS l) and the time the user has
652 been idle (from PRIVMSG only, as in WHOIS).
653 </para></listitem>
654 </varlistentry>
655 <varlistentry>
656 <term>Oper</term>
657 <listitem><para>
658 Like User, but opered.
659 </para></listitem>
660 </varlistentry>
661 <varlistentry>
662 <term>Serv</term>
663 <listitem><para>
664 A registered server.
665 Shows the number of servers and users reached via this link,
666 who made this connection and the time the server has not sent
667 anything.
668 </para></listitem>
669 </varlistentry>
670 </variablelist>
671 </sect2>
672 <sect2>
673 <title>ETRACE</title>
674 <cmdsynopsis>
675 <command>ETRACE</command>
676 <arg><replaceable>nick</replaceable></arg>
677 </cmdsynopsis>
678 <para>
679 Shows client information about the given target, or about all local clients if
680 no target is specified.
681 </para>
682 </sect2>
683 <sect2>
684 <title>MASKTRACE</title>
685 <cmdsynopsis>
686 <command>MASKTRACE</command>
687 <arg choice=plain><replaceable>hostmask</replaceable></arg>
688 <arg><replaceable>gecos</replaceable></arg>
689 </cmdsynopsis>
690 <para>
691 Searches the local server or network for users that match the hostmask and gecos given.
692 Network searches require the oper_spy privilege and an '!'
693 before the hostmask.
694 The matching works the same way as TESTMASK.
695 </para>
696 <para>
697 The <replaceable>hostmask</replaceable> is of the form user@host
698 or user@ip/cidr with * and ? wildcards, optionally preceded by
699 nick!.
700 </para>
701 <para>
702 The <replaceable>gecos</replaceable> field accepts the same wildcards
703 as xlines.
704 </para>
705 <para>
706 The IP address field contains 255.255.255.255 if the IP address
707 is unknown (remote client on a TS5 server) or 0 if the IP address
708 is hidden (auth{} spoof).
709 </para>
710 </sect2>
711 <sect2>
712 <title>CHANTRACE</title>
713 <cmdsynopsis>
714 <command>CHANTRACE</command>
715 <arg choice=plain><replaceable>channel</replaceable></arg>
716 </cmdsynopsis>
717 <para>
718 Displays information about users in a channel.
719 Opers with the oper_spy privilege
720 can get the information without being on the channel,
721 by prefixing the channel name with an '!'.
722 </para>
723 <para>
724 The IP address field contains 255.255.255.255 if the IP address
725 is unknown (remote client on a TS5 server) or 0 if the IP address
726 is hidden (auth{} spoof).
727 </para>
728 </sect2>
729 <sect2>
730 <title>SCAN</title>
731 <cmdsynopsis>
732 <command>SCAN UMODES</command>
733 <arg choice=plain>+<replaceable>modes</replaceable>-<replaceable>modes</replaceable></arg>
734 <arg>no-list</arg>
735 <arg>list</arg>
736 <arg>global</arg>
737 <arg>list-max <replaceable>number</replaceable></arg>
738 <arg>mask <replaceable>nick!user@host</replaceable></arg>
739 </cmdsynopsis>
740 <para>
741 Searches the local server or network for users that have the umodes given with + and do not have the umodes given with -.
742 no-list disables the listing of matching users and only shows the count.
743 list enables the listing (default).
744 global extends the search to the entire network instead of local users only.
745 list-max limits the listing of matching users to the given amount.
746 mask causes only users matching the given nick!user@host mask
747 to be selected. Only the displayed host is considered, not the
748 IP address or real host behind dynamic spoofs.
749 </para>
750 <para>
751 The IP address field contains 255.255.255.255 if the IP address
752 is unknown (remote client on a TS5 server) or 0 if the IP address
753 is hidden (auth{} spoof).
754 </para>
755 <para>
756 Network searches where a listing is given or the mask option is used
757 are operspy commands.
758 </para>
759 </sect2>
760 <sect2>
761 <title>CHGHOST</title>
762 <cmdsynopsis>
763 <command>CHGHOST</command>
764 <arg choice=plain><replaceable>nick</replaceable></arg>
765 <arg choice=plain><replaceable>value</replaceable></arg>
766 </cmdsynopsis>
767 <para>
768 Set the hostname associated with a particular nick for the duration of this session.
769 This command is disabled by default because of the abuse potential
770 and little practical use.
771 </para>
772 </sect2>
773 </sect1>
774 <sect1 id="misccommands">
775 <title>Miscellaneous commands</title>
776 <sect2>
777 <title>ADMIN</title>
778 <cmdsynopsis>
779 <command>ADMIN</command>
780 <group>
781 <arg><replaceable>nick</replaceable></arg>
782 <arg><replaceable>server</replaceable></arg>
783 </group>
784 </cmdsynopsis>
785 <para>
786 Shows the information in the admin{} block.
787 </para>
788 </sect2>
789 <sect2>
790 <title>INFO</title>
791 <cmdsynopsis>
792 <command>INFO</command>
793 <group>
794 <arg><replaceable>nick</replaceable></arg>
795 <arg><replaceable>server</replaceable></arg>
796 </group>
797 </cmdsynopsis>
798 <para>
799 Shows information about the authors of the IRC server, and
800 some information about this server instance.
801 Opers also get a list of configuration options.
802 </para>
803 </sect2>
804 <sect2>
805 <title>TIME</title>
806 <cmdsynopsis>
807 <command>TIME</command>
808 <group>
809 <arg><replaceable>nick</replaceable></arg>
810 <arg><replaceable>server</replaceable></arg>
811 </group>
812 </cmdsynopsis>
813 <para>
814 Shows the local time on the given server, in a human-readable format.
815 </para>
816 </sect2>
817 <sect2>
818 <title>VERSION</title>
819 <cmdsynopsis>
820 <command>VERSION</command>
821 <group>
822 <arg><replaceable>nick</replaceable></arg>
823 <arg><replaceable>server</replaceable></arg>
824 </group>
825 </cmdsynopsis>
826 <para>
827 Shows version information, a few compile/config options,
828 the SID and the 005 numerics.
829 The 005 numeric will be remapped to 105 for remote requests.
830 </para>
831 </sect2>
832 <sect2>
833 <title>STATS</title>
834 <cmdsynopsis>
835 <command>STATS</command>
836 <arg><replaceable>type</replaceable></arg>
837 <group>
838 <arg><replaceable>nick</replaceable></arg>
839 <arg><replaceable>server</replaceable></arg>
840 </group>
841 </cmdsynopsis>
842 <para>
843 Display various statistics and configuration information.
844 </para>
845 <variablelist>
846 <title>Values for <replaceable>type</replaceable></title>
847 <varlistentry>
848 <term>A</term>
849 <listitem>
850 <para>Show DNS servers</para>
851 </listitem>
852 </varlistentry>
853 <varlistentry>
854 <term>b</term>
855 <listitem>
856 <para>Show active nick delays</para>
857 </listitem>
858 </varlistentry>
859 <varlistentry>
860 <term>B</term>
861 <listitem>
862 <para>Show hash statistics</para>
863 </listitem>
864 </varlistentry>
865 <varlistentry>
866 <term>c</term>
867 <listitem>
868 <para>Show connect blocks</para>
869 </listitem>
870 </varlistentry>
871 <varlistentry>
872 <term>d</term>
873 <listitem>
874 <para>Show temporary D:lines</para>
875 </listitem>
876 </varlistentry>
877 <varlistentry>
878 <term>D</term>
879 <listitem>
880 <para>Show permanent D:lines</para>
881 </listitem>
882 </varlistentry>
883 <varlistentry>
884 <term>e</term>
885 <listitem>
886 <para>Show exempt blocks (exceptions to D:lines)</para>
887 </listitem>
888 </varlistentry>
889 <varlistentry>
890 <term>E</term>
891 <listitem>
892 <para>Show events</para>
893 </listitem>
894 </varlistentry>
895 <varlistentry>
896 <term>f</term>
897 <listitem>
898 <para>Show file descriptors</para>
899 </listitem>
900 </varlistentry>
901 <varlistentry>
902 <term>g</term>
903 <listitem>
904 <para>Show pending glines</para>
905 </listitem>
906 </varlistentry>
907 <varlistentry>
908 <term>G</term>
909 <listitem>
910 <para>Show active glines</para>
911 </listitem>
912 </varlistentry>
913 <varlistentry>
914 <term>h</term>
915 <listitem>
916 <para>Show hub_mask/leaf_mask</para>
917 </listitem>
918 </varlistentry>
919 <varlistentry>
920 <term>i</term>
921 <listitem>
922 <para>Show auth blocks, or matched auth blocks</para>
923 </listitem>
924 </varlistentry>
925 <varlistentry>
926 <term>k</term>
927 <listitem>
928 <para>Show temporary K:lines, or matched K:lines</para>
929 </listitem>
930 </varlistentry>
931 <varlistentry>
932 <term>K</term>
933 <listitem>
934 <para>Show permanent K:lines, or matched K:lines</para>
935 </listitem>
936 </varlistentry>
937 <varlistentry>
938 <term>l</term>
939 <listitem>
940 <para>
941 Show hostname and link information about the given nick.
942 With a server name, show information about opers and servers
943 on that server; opers also get information about all local users
944 if they query their own server.
945 </para>
946 </listitem>
947 </varlistentry>
948 <varlistentry>
949 <term>L</term>
950 <listitem>
951 <para>Like l, but show IP address instead of hostname</para>
952 </listitem>
953 </varlistentry>
954 <varlistentry>
955 <term>m</term>
956 <listitem>
957 <para>Show commands and their usage statistics (total counts, total bytes, counts from server connections)</para>
958 </listitem>
959 </varlistentry>
960 <varlistentry>
961 <term>n</term>
962 <listitem>
963 <para>Show blacklist blocks (DNS blacklists) with hit counts.</para>
964 </listitem>
965 </varlistentry>
966 <varlistentry>
967 <term>o</term>
968 <listitem>
969 <para>Show operator blocks</para>
970 </listitem>
971 </varlistentry>
972 <varlistentry>
973 <term>p</term>
974 <listitem>
975 <para>Show logged on network operators which are not set AWAY.</para>
976 </listitem>
977 </varlistentry>
978 <varlistentry>
979 <term>P</term>
980 <listitem>
981 <para>Show listen blocks</para>
982 </listitem>
983 </varlistentry>
984 <varlistentry>
985 <term>q</term>
986 <listitem>
987 <para>Show temporarily resv'ed nicks and channels</para>
988 </listitem>
989 </varlistentry>
990 <varlistentry>
991 <term>Q</term>
992 <listitem>
993 <para>Show permanently resv'ed nicks and channels</para>
994 </listitem>
995 </varlistentry>
996 <varlistentry>
997 <term>r</term>
998 <listitem>
999 <para>Show resource usage by the ircd</para>
1000 </listitem>
1001 </varlistentry>
1002 <varlistentry>
1003 <term>t</term>
1004 <listitem>
1005 <para>Show generic server statistics</para>
1006 </listitem>
1007 </varlistentry>
1008 <varlistentry>
1009 <term>u</term>
1010 <listitem>
1011 <para>Show server uptime</para>
1012 </listitem>
1013 </varlistentry>
1014 <varlistentry>
1015 <term>U</term>
1016 <listitem>
1017 <para>Show shared (c), cluster (C) and service (s) blocks</para>
1018 </listitem>
1019 </varlistentry>
1020 <varlistentry>
1021 <term>v</term>
1022 <listitem>
1023 <para>Show connected servers and brief status</para>
1024 </listitem>
1025 </varlistentry>
1026 <varlistentry>
1027 <term>x</term>
1028 <listitem>
1029 <para>Show temporary X:lines</para>
1030 </listitem>
1031 </varlistentry>
1032 <varlistentry>
1033 <term>X</term>
1034 <listitem>
1035 <para>Show permanent X:lines</para>
1036 </listitem>
1037 </varlistentry>
1038 <varlistentry>
1039 <term>y</term>
1040 <listitem>
1041 <para>Show class blocks</para>
1042 </listitem>
1043 </varlistentry>
1044 <varlistentry>
1045 <term>z</term>
1046 <listitem>
1047 <para>Show memory usage statistics</para>
1048 </listitem>
1049 </varlistentry>
1050 <varlistentry>
1051 <term>Z</term>
1052 <listitem>
1053 <para>Show ziplinks statistics</para>
1054 </listitem>
1055 </varlistentry>
1056 <varlistentry>
1057 <term>?</term>
1058 <listitem>
1059 <para>Show connected servers and sendq information about them</para>
1060 </listitem>
1061 </varlistentry>
1062 </variablelist>
1063 </sect2>
1064 <sect2>
1065 <title>WALLOPS</title>
1066 <cmdsynopsis>
1067 <command>WALLOPS</command>
1068 <arg choice=plain>:<replaceable>message</replaceable></arg>
1069 </cmdsynopsis>
1070 <para>
1071 Sends a WALLOPS message to all users who have the +w umode set. This is for
1072 things you don't mind the whole network knowing about.
1073 </para>
1074 </sect2>
1075 <sect2>
1076 <title>OPERWALL</title>
1077 <cmdsynopsis>
1078 <command>OPERWALL</command>
1079 <arg choice=plain>:<replaceable>message</replaceable></arg>
1080 </cmdsynopsis>
1081 <para>
1082 Sends an OPERWALL message to all opers who have the +z umode set. +z is restricted,
1083 OPERWALL should be considered private communications.
1084 </para>
1085 </sect2>
1086 </sect1>
1087 </chapter>
1088 <!-- Keep this comment at the end of the file
1089 Local variables:
1090 mode: sgml
1091 sgml-omittag:t
1092 sgml-shorttag:t
1093 sgml-namecase-general:t
1094 sgml-general-insert-case:lower
1095 sgml-minimize-attributes:nil
1096 sgml-always-quote-attributes:t
1097 sgml-indent-step:2
1098 sgml-indent-data:t
1099 sgml-parent-document: ("charybdis-oper-guide.sgml" "book")
1100 sgml-exposed-tags:nil
1101 sgml-local-ecat-files:nil
1102 fill-column:105
1103 End:
1104 -->