]> jfr.im git - irc/rqf/shadowircd.git/blame - doc/technical/ts6-protocol.txt
Improve technical documentation of BAN protocol.
[irc/rqf/shadowircd.git] / doc / technical / ts6-protocol.txt
CommitLineData
03a905bd
JT
1TS6 protocol description
2Written by Jilles Tjoelker
3
4General format: much like rfc1459
5Maximum parameters for a command: 15 (this does not include the prefix
6and command name)
7
8SID: a server's unique ID. It is configured in each server and consists of
9a digit and two alphanumerics. Sending SIDs with lowercase letters is
10questionable.
11
12UID: a client's unique ID. It consists of the server's SID and six
13alphanumerics (so it is nine characters long). The first of the alphanumerics
14should be a letter, numbers are legal but reserved for future use.
15
16hunted: a parameter type used for various remote requests. From local users,
17nicknames and server names are accepted, possibly with wildcards; from servers,
18UIDs/SIDs (sending names or even wildcards is deprecated). This is done with
19the function hunt_server(). Any rate limiting should be done locally.
20
21duration: a parameter type used for ban durations. It is a duration in seconds.
22A value of 0 means a permanent ban.
23
71059b1f
JT
24propagation: to which other servers the command is sent
25
26For all commands with a hunted parameter, the propagation is determined by
27that, and not otherwise specified.
28
29For all commands with a target server mask parameter, the propagation is
30determined by that, and not otherwise specified. The command is sent to all
31servers with names matching the given mask (for example '*', '*.example.com',
32'irc.example.com'). Those servers do not have to be directly connected.
33Targets cannot be SIDs.
34
35Propagation broadcast means the command is sent to all servers.
36
37Propagation one-to-one means the command is only sent to the target or the
38server the target is on.
39
40Propagation none means the command is never sent to another server if it is
41received.
42
43For some other commands, the propagation depends on the parameters and is
44described in text.
03a905bd
JT
45
46services server: server mentioned in a service{} block. There are no services
47servers on EFnet.
48
49service: client with umode +S. This implies that it is on a services server.
50
dc83edfa
JT
51connection setup:
52The initiator sends the PASS, CAPAB and SERVER messages. Upon receiving the
53SERVER, the listener will check the information, and if it is valid, it will
54send its own PASS, CAPAB and SERVER messages, followed by SVINFO and the burst.
55Upon receiving the SERVER, the initiator will send SVINFO and the burst. If
56ziplinks are used, SVINFO is the first compressed message.
57
51796761
JT
58The burst consists of SID and SERVER messages for all known servers, BAN
59messages for all propagated bans, UID or EUID messages for all known users
60(possibly followed by ENCAP REALHOST, ENCAP LOGIN and/or AWAY) and SJOIN
61messages for all known channels (possibly followed by BMASK and/or TB).
dc83edfa 62
03a905bd
JT
63user modes:
64(all)
65+D (deaf: does not receive channel messages)
66+S (network service) (only settable on burst from a services server)
67+a (appears as server administrator)
68+i (invisible, see rfc1459)
69+o (IRC operator, see rfc1459)
70+w (wallops, see rfc1459) (always propagated for historical reasons)
71(charybdis TS6)
72+Q/+R/+g/+l/+s/+z (only locally effective)
73+Z (ssl user) (only settable on burst)
74possibly more added by modules
75
76channel modes:
77(all)
78statuses
79+o (prefix @) (ops)
80+v (prefix +) (voice)
81type A
82+b (ban)
7f9423cb
JT
83+e (ban exception) (capab: EX)
84+I (invite exception) (capab: IE)
03a905bd
JT
85type B
86+k (key: password required to join, <= 23 ascii chars, no : or , or whitespace)
87type C
88+l (limit: maximum number of members before further joins are disallowed)
89type D
90+m (moderated)
91+n (no external messages)
92+p (private: does not appear in /whois to non-members, no /knock allowed)
7f9423cb 93+r (only registered users may join) (only if a services server exists) (capab: SERVICES)
03a905bd
JT
94+s (secret)
95+t (only chanops may change topic)
96(charybdis TS6)
97type A
98+q (quiet)
99type C
100+f (forward: channel name <= 30 chars)
101+j (join throttle: N:T with integer N and T)
102type D
103+F (free target for +f)
104+L (large ban list)
105+P (permanent: does not disappear when empty)
106+Q (ignore forwards to this)
107+c (strip colours)
108+g (allow any member to /invite)
109+z (send messages blocked by +m to chanops)
110
fbe27d50
JT
111<numeric>
112source: server
113parameters: target, any...
114
115The command name should be three decimal ASCII digits.
116
117Propagates a "numeric" command reply, such as from a remote WHOIS request.
118
119If the first digit is 0 (indicating a reply about the local connection), it
120should be changed to 1 before propagation or sending to a user.
121
122Numerics to the local server may be sent to opers.
123
124To avoid infinite loops, servers should not send any replies to numerics.
125
126The target can be:
127- a client
128 propagation: one-to-one
129- a channel name
130 propagation: all servers with -D users on the channel
131
132Numerics to channels are broken in some older servers.
133
03a905bd
JT
134ADMIN
135source: user
136parameters: hunted
137
138Remote ADMIN request.
139
140AWAY
141source: user
142propagation: broadcast
143parameters: opt. away reason
144
145If the away reason is empty or not present, mark the user as not away.
146Otherwise, mark the user as away.
147
148Changing away reason from one non-empty string to another non-empty string
149may not be propagated.
150
51796761
JT
151BAN
152charybdis TS6
153capab: BAN
154source: any
155propagation: broadcast (restricted)
156parameters: type, user mask, host mask, creation TS, duration, lifetime, oper, reason
157
158Propagates a network wide ban.
159
9dc68130
JT
160The type is K for K:lines, R for resvs and X for X:lines; other types are
161reserved. The user mask field is only used for K:lines; for resvs and X:lines
162the field is ignored in input and sent as an asterisk.
51796761
JT
163
164The creation TS indicates when this ban was last modified. An incoming ban MUST
165be ignored and not propagated if the creation TS is older than the creation TS
166of the current ban. If the ban is identical, it SHOULD NOT be propagated to
167avoid unnecessary network traffic. (Two changes to bans that set the TS to the
168same value may cause desynchronization.)
169
170The duration is 0 for an unban and relative to the creation TS for a ban.
171When the duration has passed, the ban is no longer active but it may still
172be necessary to remember it.
173
174The lifetime is relative to the creation TS and indicates for how long this
175ban needs to be remembered and propagated. This MUST be at least the duration.
176Initially, it is usually set the same as the duration but when the ban is
177modified later, it SHOULD be set such that the modified ban is remembered at
178least as long as the original ban. This ensures that the original ban does not
179revive via split servers. This requirement is only a SHOULD to allow for
180implementations that only inject bans and do not remember any; implementations
181that remember and propagate bans MUST set the lifetime appropriately.
182
183The oper field indicates the oper that originally set the ban. If this message
184is the initial propagation of a change, it SHOULD be sent as * (an asterisk).
185
186The reason field indicates the reason for the ban. Any part after a | (vertical
187bar) MUST NOT be shown to normal users. The rest of the field and the creation
188TS and duration MAY be shown to normal users.
189
03a905bd
JT
190BMASK
191source: server
192propagation: broadcast
193parameters: channelTS, channel, type, space separated masks
194
195If the channelTS in the message is greater (newer) than the current TS of
196the channel, drop the message and do not propagate it.
197
198Type is the mode letter of a ban-like mode. In efnet TS6 this is 'b', 'e' or
199'I'. In charybdis TS6 additionally 'q' is possible.
200
201Add all the masks to the given list of the channel.
202
203All ban-like modes must be bursted using this command, not using MODE or TMODE.
204
205CAPAB
206source: unregistered server
207propagation: none
208parameters: space separated capability list
209
dc83edfa
JT
210Sends capabilities of the server. This must include QS and ENCAP. It is also
211strongly recommended to include EX, CHW, IE and KNOCK, and for charybdis TS6
212also SAVE and EUID. For use with services, SERVICES and RSFNC are strongly
213recommended.
214
215The capabilities may depend on the configuration for the server they are sent
216to.
03a905bd
JT
217
218CHGHOST
219charybdis TS6
220source: any
221propagation: broadcast
222parameters: client, new hostname
223
224Changes the visible hostname of a client.
225
226Opers are notified unless the source is a server or a service.
227
228CONNECT
229source: any
230parameters: server to connect to, port, hunted
231
232Remote connect request. A server WALLOPS should be sent by the receiving
233server.
234
235The port can be 0 for the default port.
236
237DLINE
238charybdis TS6
239encap only
240source: user
241parameters: duration, mask, reason
242
243Sets a D:line (IP ban checked directly after accepting connection).
244
245The mask must be an IP address or CIDR mask.
246
247ENCAP
248source: any
249parameters: target server mask, subcommand, opt. parameters...
250
71059b1f
JT
251Sends a command to matching servers. Propagation is independent of
252understanding the subcommand.
03a905bd 253
71059b1f 254Subcommands are listed elsewhere with "encap only".
03a905bd
JT
255
256ERROR
257source: server or unregistered server
258propagation: none
259parameters: error message
260
261Reports a (usually fatal) error with the connection.
262
263Error messages may contain IP addresses and have a negative effect on server
264IP hiding.
265
266ETRACE
267encap only
268encap target: single server
269source: oper
270parameters: client
271
272Remote ETRACE information request.
273
274EUID
275charybdis TS6
276capab: EUID
277source: server
278parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, real hostname, account name, gecos
279propagation: broadcast
280
281Introduces a client. The client is on the source server of this command.
282
283The account name is '0' if the user is not logged in with services.
284
285Nick TS rules apply.
286
287EUID is similar to UID but includes the ENCAP REALHOST and ENCAP LOGIN
288information.
289
290GCAP
291encap only
292encap target: *
293source: server
294parameters: space separated capability list
295
296Capability list of remote server.
297
d2d703a1
JT
298GLINE
299efnet TS6
300capab: GLN
301source: user
302parameters: user mask, host mask, reason
303propagation: broadcast
304
305Propagates a G:line vote. Once votes from three different opers (based on
306user@host mask) on three different servers have arrived, trigger the G:line.
307Pending G:lines expire after some time, usually ten minutes. Triggered G:lines
308expire after a configured time which may differ across servers.
309
310Requests from server connections must be propagated, unless they are found to
311be syntactically invalid (e.g. '!' in user mask). Therefore, disabling glines
312must not affect propagation, and too wide glines, double votes and glines that
313already exist locally must still be propagated.
314
315Of course, servers are free to reject gline requests from their own operators.
316
c066192c
JT
317GUNGLINE
318efnet TS6
319encap only
320encap target: *
321source: user
322parameters: user mask, host mask, reason
323propagation: broadcast
324
325Propagates a G:line removal vote. Once three votes have arrived (as with
326G:lines), remove the G:line. Pending G:lines removals expire after some time,
327usually ten minutes.
328
329Pending G:line removals do not interact with pending G:lines. Triggering a
330G:line does not affect a pending G:line removal. Triggering a G:line removal
331does not affect a pending G:line.
332
03a905bd
JT
333INFO
334source: user
335parameters: hunted
336
337Remote INFO request.
338
339INVITE
340source: user
341parameters: target user, channel, opt. channelTS
342propagation: one-to-one
343
344Invites a user to a channel.
345
346If the channelTS is greater (newer) than the current TS of the channel, drop
347the message.
348
349Not sending the channelTS parameter is deprecated.
350
351JOIN
3521.
353source: user
354parameters: '0' (one ASCII zero)
355propagation: broadcast
356
357Parts the source user from all channels.
358
3592.
360source: user
361parameters: channelTS, channel, '+' (a plus sign)
362propagation: broadcast
363
364Joins the source user to the given channel. If the channel does not exist yet,
365it is created with the given channelTS and no modes. If the channel already
366exists and has a greater (newer) TS, wipe all simple modes and statuses and
367change the TS, notifying local users of this but not servers (note that
368ban-like modes remain intact; invites may or may not be cleared).
369
b573143f
JT
370A JOIN is propagated with the new TS of the channel.
371
03a905bd
JT
372KICK
373source: any
374parameters: channel, target user, opt. reason
375propagation: broadcast
376
377Kicks the target user from the given channel.
378
379Unless the channel's TS is 0, no check is done whether the source user has ops.
380
381Not sending the reason parameter is questionable.
382
383KILL
384source: any
385parameters: target user, path
386propagation: broadcast
387
388Removes the user from the network.
389
390The format of the path parameter is some sort of description of the source of
391the kill followed by a space and a parenthesized reason. To avoid overflow,
392it is recommended not to add anything to the path.
393
394KLINE
3951.
396encap only
397source: user
398parameters: duration, user mask, host mask, reason
399
400Sets a K:line (ban on user@host).
401
4022.
403capab: KLN
404source: user
405parameters: target server mask, duration, user mask, host mask, reason
406
407As form 1, deprecated.
408
409KNOCK
7f9423cb 410capab: KNOCK
03a905bd
JT
411source: user
412parameters: channel
413propagation: broadcast
414
415Requests an invite to a channel that is locked somehow (+ikl). Notifies all
416operators of the channel. (In charybdis, on +g channels all members are
417notified.)
418
419This is broadcast so that each server can store when KNOCK was used last on
420a channel.
421
422LINKS
423source: user
424parameters: hunted, server mask
425
426Remote LINKS request. The server mask limits which servers are listed.
427
640b57ec
JT
428LOCOPS
4291.
430encap only
431source: user
432parameters: text
433
434Sends a message to operators (with umode +l set). This is intended to be
435used for strict subsets of the network.
436
4372.
438capab: CLUSTER
439source: user
440parameters: target server mask, text
441
442As form 1, deprecated.
443
03a905bd
JT
444LOGIN
445encap only
446source: user
447parameters: account name
448
449In a burst, states that the source user is logged in as the account.
450
451LUSERS
452source: user
453parameters: server mask, hunted
454
455Remote LUSERS request. Most servers ignore the server mask, treating it as '*'.
456
457MODE
4581.
459source: user
460parameters: client, umode changes
461propagation: broadcast
462
463Propagates a user mode change. The client parameter must refer to the same user
464as the source.
465
466Not all umodes are propagated to other servers.
467
4682.
469source: any
470parameters: channel, cmode changes, opt. cmode parameters...
471
472Propagates a channel mode change.
473
474This is deprecated because the channelTS is not included. If it is received,
475it should be propagated as TMODE.
476
477MOTD
478source: user
479parameters: hunted
480
481Remote MOTD request.
482
483NICK
4841.
485source: user
486parameters: new nickname, new nickTS
487propagation: broadcast
488
489Propagates a nick change.
490
4912.
492source: server
493parameters: nickname, hopcount, nickTS, umodes, username, hostname, server, gecos
494
495Historic TS5 user introduction. The user is on the server indicated by the
496server parameter; the source server is meaningless (local link).
497
498NICKDELAY
499charybdis TS6
500encap only
501encap target: *
502source: services server
503parameters: duration, nickname
504
505If duration is greater than 0, makes the given nickname unavailable for that
506time.
507
508If duration is 0, removes a nick delay entry for the given nickname.
509
510There may or may not be a client with the given nickname; this does not affect
511the operation.
512
513NOTICE
514source: any
515parameters: msgtarget, message
516
517As PRIVMSG, except NOTICE messages are sent out, server sources are permitted
518and most error messages are suppressed.
519
16834df2
JT
520Servers may not send '$$', '$#' and opers@server notices. Older servers may
521not allow servers to send to specific statuses on a channel.
522
03a905bd
JT
523OPERSPY
524encap only
525encap target: *
526source: user
527parameters: command name, parameters
528
529Reports operspy usage.
530
531OPERWALL
532source: user
533parameters: message
534propagation: broadcast
535
536Sends a message to operators (with umode +z set).
537
538PART
539source: user
540parameters: comma separated channel list, message
541
542Parts the source user from the given channels.
543
544PASS
545source: unregistered server
546parameters: password, 'TS', TS version, SID
547
548Sends the server link password, TS version and SID.
549
550PING
551source: any
dc83edfa 552parameters: origin, opt. destination server
03a905bd 553
dc83edfa
JT
554Sends a PING to the destination server, which will reply with a PONG. If the
555destination server parameter is not present, the server receiving the message
556must reply.
03a905bd 557
dc83edfa
JT
558The origin field is not used in the server protocol. It is sent as the name
559(not UID/SID) of the source.
03a905bd
JT
560
561Remote PINGs are used for end-of-burst detection, therefore all servers must
562implement them.
563
564PONG
565source: server
566parameters: origin, destination
567
568Routes a PONG back to the destination that originally sent the PING.
569
570PRIVMSG
571source: user
572parameters: msgtarget, message
573
574Sends a normal message (PRIVMSG) to the given target.
575
576The target can be:
577- a client
578 propagation: one-to-one
579- a channel name
580 propagation: all servers with -D users on the channel
581 (cmode +m/+n should be checked everywhere, bans should not be checked
582 remotely)
583- a status character ('@'/'+') followed by a channel name, to send to users
584 with that status or higher only.
b03d7880 585 capab: CHW
03a905bd 586 propagation: all servers with -D users with appropriate status
6ce8910d
JT
587- '=' followed by a channel name, to send to chanops only, for cmode +z.
588 capab: CHW and EOPMOD
589 propagation: all servers with -D chanops
03a905bd
JT
590- a user@server message, to send to users on a specific server. The exact
591 meaning of the part before the '@' is not prescribed, except that "opers"
592 allows IRC operators to send to all IRC operators on the server in an
593 unspecified format.
594 propagation: one-to-one
595- a message to all users on server names matching a mask ('$$' followed by mask)
596 propagation: broadcast
16834df2 597 Only allowed to IRC operators.
03a905bd
JT
598- a message to all users with hostnames matching a mask ('$#' followed by mask).
599 Note that this is often implemented poorly.
600 propagation: broadcast
16834df2
JT
601 Only allowed to IRC operators.
602
603In charybdis TS6, services may send to any channel and to statuses on any
604channel.
03a905bd
JT
605
606PRIVS
607charybdis TS6
608encap only
609encap target: single server
610source: oper
611parameters: client
612
613Remote PRIVS information request.
614
615QUIT
616source: user
617parameters: comment
618
619Propagates quitting of a client. No QUIT should be sent for a client that
620has been removed as result of a KILL message.
621
622REALHOST
623charybdis TS6
624encap only
625encap target: *
626source: user
627parameters: real hostname
628
629In a burst, propagates the real host of a dynamically-spoofed user.
630
631REHASH
632charybdis TS6
633encap only
634source: user
635parameters: opt. rehash type
636
637Remote REHASH request. If the rehash type is omitted, it is equivalent to
638a regular /rehash, otherwise it is equivalent to /rehash <rehash type>.
639
640RESV
6411.
642encap only
643source: user
644parameters: duration, mask, reason
645
646Sets a RESV, making a nickname mask or exact channel unavailable.
647
6482.
649capab: CLUSTER
650source: user
651parameters: target server mask, duration, mask, reason
652
653As form 1, deprecated.
654
655RSFNC
656encap only
657capab: RSFNC
658encap target: single server
659source: services server
660parameters: target user, new nickname, old nickTS, new nickTS
661
662Forces a nickname change and propagates it.
663
664The command is ignored if the nick TS of the user is not equal to the old
665nickTS parameter. If the new nickname already exists (and is not the target
666user), it is killed first.
667
668SASL
669charybdis TS6
670encap only
6711.
672encap target: *
673source: server
674parameters: source uid, '*', 'S', sasl mechanism name
675
676Requests that a SASL agent (a service) initiate the authentication process.
677The source uid is that of an unregistered client. This is why it is not sent
678as the prefix.
679
6802.
681encap target: single server
682source: server
683parameters: source uid, target uid, mode, data
684
685Part of a SASL authentication exchange. The mode is 'C' to send some data
686(base64 encoded), or 'S' to end the exchange (data indicates type of
687termination: 'A' for abort, 'F' for authentication failure, 'S' for
688authentication success).
689
690SAVE
691capab: SAVE
692source: server
693propagation: broadcast
694parameters: target uid, TS
695
696Resolve a nick collision by changing a nickname to the UID.
697
698The server should verify that the UID belongs to a registered user, the user
699does not already have their UID as their nick and the TS matches the user's
700nickTS. If not, drop the message.
701
702SAVE should be propagated as a regular NICK change to links without SAVE capab.
703present.
704
705SERVER
7061.
707source: unregistered server
708parameters: server name, hopcount, server description
709
710Registers the connection as a server. PASS and CAPAB must have been sent
711before, SVINFO should be sent afterwards.
712
713If there is no such server configured or authentication failed, the connection
714should be dropped.
715
716This is propagated as a SID message.
717
7182.
719source: server
720propagation: broadcast
721parameters: server name, hopcount, server description
722
723Introduces a new TS5 server, directly connected to the source of this command.
724This is only used for jupes as TS5 servers may do little else than existing.
725
726SID
727source: server
728propagation: broadcast
729parameters: server name, hopcount, sid, server description
730
731Introduces a new server, directly connected to the source of this command.
732
733SIGNON
734source: user
735propagation: broadcast
736parameters: new nickname, new username, new visible hostname, new nickTS, new login name
737
738Broadcasts a change of several user parameters at once.
739
740Currently only sent after an SVSLOGIN.
741
742SJOIN
743source: server
744propagation: broadcast
745parameters: channelTS, simple modes, opt. mode parameters..., nicklist
746
747Broadcasts a channel creation or bursts a channel.
748
749The nicklist consists of users joining the channel, with status prefixes for
750their status ('@+', '@', '+' or ''), for example:
751'@+1JJAAAAAB +2JJAAAA4C 1JJAAAADS'. All users must be behind the source server
752so it is not possible to use this message to force users to join a channel.
753
754The interpretation depends on the channelTS and the current TS of the channel.
755If either is 0, set the channel's TS to 0 and accept all modes. Otherwise, if
756the incoming channelTS is greater (newer), ignore the incoming simple modes
757and statuses and join and propagate just the users. If the incoming channelTS
758is lower (older), wipe all modes and change the TS, notifying local users of
759this but not servers (invites may be cleared). In the latter case, kick on
760split riding may happen: if the key (+k) differs or the incoming simple modes
761include +i, kick all local users, sending KICK messages to servers.
762
b573143f
JT
763An SJOIN is propagated with the new TS and modes of the channel. The statuses
764are propagated if and only if they were accepted.
765
03a905bd
JT
766SJOIN must be used to propagate channel creation and in netbursts. For regular
767users joining channels, JOIN must be used. Pseudoservers may use SJOIN to join
768a user with ops.
769
770SNOTE
771charybdis TS6
772encap only
773source: server
774parameters: snomask letter, text
775
776Sends the text as a server notice from the source server to opers with the
777given snomask set.
778
779SQUIT
780parameters: target server, comment
781
782Removes the target server and all servers and users behind it from the network.
783
784If the target server is the receiving server or the local link this came from,
785this is an announcement that the link is being closed.
786
787Otherwise, if the target server is locally connected, the server should send
788a WALLOPS announcing the SQUIT.
789
790STATS
791source: user
792parameters: stats letter, hunted
793
794Remote STATS request. Privileges are checked on the server executing the
795actual request.
796
797SU
798encap only
799encap target: *
800source: services server
801parameters: target user, new login name (optional)
802
803If the new login name is not present or empty, mark the target user as not
804logged in, otherwise mark the target user as logged in as the given account.
805
806SVINFO
807source: server
808propagation: none
809parameters: current TS version, minimum TS version, '0', current time
810
811Verifies TS protocol compatibility and clock. If anything is not in order,
812the link is dropped.
813
814The current TS version is the highest version supported by the source server
815and the minimum TS version is the lowest version supported.
816
817The current time is sent as a TS in the usual way.
818
819SVSLOGIN
820charybdis TS6
821encap only
822encap target: single server
823source: services server
824parameters: target, new nick, new username, new visible hostname, new login name
825
826Sent after successful SASL authentication.
827
828The target is a UID, typically an unregistered one.
829
830Any of the "new" parameters can be '*' to leave the corresponding field
831unchanged. The new login name can be '0' to log the user out.
832
833If the UID is registered on the network, a SIGNON with the changes will be
834broadcast, otherwise the changes will be stored, to be used when registration
835completes.
836
837TB
1773e9cb 838capab: TB
03a905bd
JT
839source: server
840propagation: broadcast
1773e9cb
JT
841parameters: channel, topicTS, opt. topic setter, topic
842
843Propagates a channel topic as part of a burst.
844
845If the channel had no topic yet or the topicTS in the message is older than
846the topicTS of the current topic on the channel and the topics differ, set
847the topic with topicTS and topic setter, and propagate the message. Otherwise
848ignore the message and do not propagate it.
849
850If the topic setter is not present, use a server name instead.
03a905bd
JT
851
852TIME
853source: user
854parameters: hunted
855
856Remote TIME request.
857
858TMODE
859source: any
860parameters: channelTS, channel, cmode changes, opt. cmode parameters...
861
862Propagates a channel mode change.
863
864If the channelTS is greater (newer) than the current TS of the channel, drop
865the message.
866
867On input, only the limit on parameters per line restricts how many cmode
868parameters can be present. Apart from this, arbitrary modes shall be
869processed. Redundant modes may be dropped. For example, +n-n may be applied and
870propagated as +n-n, -n or (if the channel was already -n) nothing, but not as
871+n.
872
873The parameter for mode -k (removing a key) shall be ignored.
874
875On output, at most ten cmode parameters should be sent; if there are more,
876multiple TMODE messages should be sent.
877
878TOPIC
879source: user
880propagation: broadcast
1773e9cb 881parameters: channel, topic
03a905bd
JT
882
883Propagates a channel topic change. The server may verify that the source has
884ops in the channel.
885
1773e9cb
JT
886The topicTS shall be set to the current time and the topic setter shall be
887set indicating the source user. Note that this means that the topicTS of a
888topic set with TOPIC is not necessarily consistent across the network.
889
03a905bd
JT
890TRACE
891source: user
8921.
893parameters: hunted
894
895Performs a trace to the target, sending 200 numerics from each server passing
896the message on. The target server sends a description of the target followed
897by a 262 numeric.
898
899TRACE, STATS l and STATS L are the only commands using hunt_server that use the
900hunted parameter for more than just determining which server the command
901should be executed on.
902
9032.
904parameters: target name, hunted
905
906Executes a trace command on the target server. No 200 numerics are sent.
907The target name is a name, not a UID, and should be on the target server.
908
909UID
910source: server
911propagation: broadcast
912parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, gecos
913propagation: broadcast
914
915Introduces a client. The client is on the source server of this command.
916
917Nick TS rules apply.
918
919UNDLINE
920charybdis TS6
921encap only
922source: user
923parameters: mask
924
925Removes a D:line (IP ban checked directly after accepting connection).
926
927The mask must be an IP address or CIDR mask.
928
929UNKLINE
9301.
931encap only
932source: user
933parameters: user mask, host mask
934
935Removes a K:line (ban on user@host).
936
9372.
938capab: UNKLN
939source: user
940parameters: target server mask, user mask, host mask
941
942As form 1, deprecated.
943
944UNRESV
9451.
946encap only
947source: user
948parameters: mask
949
950Removes a RESV.
951
9522.
953capab: CLUSTER
954source: user
955parameters: target server mask, mask
956
957As form 1, deprecated.
958
959UNXLINE
9601.
961encap only
962source: user
963parameters: mask
964
965Removes an X:line (ban on realname).
966
9672.
968capab: CLUSTER
969source: user
970parameters: target server mask, mask
971
972As form 1, deprecated.
973
974USERS
975source: user
976parameters: hunted
977
978Remote USERS request.
979
980VERSION
981source: any
982parameters: hunted
983
984Remote VERSION request.
985
986WALLOPS
9871.
988source: user
989parameters: message
990propagation: broadcast
991
992In efnet TS6, sends a message to operators (with umode +z set). This is a
993deprecated equivalent to OPERWALL.
994
995In charybdis TS6, sends a message to local users with umode +w set (or possibly
996another indication that WALLOPS messages should be sent), including non-opers.
997
9982.
999source: server
1000parameters: message
1001propagation: broadcast
1002
1003Sends a message to local users with umode +w set (or possibly another
1004indication that WALLOPS messages should be sent).
1005
1006In efnet TS6 this may include non-opers, in charybdis TS6 this may only be
1007sent to opers.
1008
1009WHOIS
1010source: user
1011parameters: hunted, target nick
1012
1013Remote WHOIS request.
1014
1015XLINE
10161.
1017encap only
1018source: user
1019parameters: duration, mask, reason
1020
1021Sets an X:line (ban on realname).
1022
10232.
1024capab: CLUSTER
1025source: user
1026parameters: target server mask, duration, mask, reason
1027
1028As form 1, deprecated.
1029
1030Local only commands (charybdis 3.1):
1031
1032ACCEPT
1033AUTHENTICATE
1034CAP
1035CHALLENGE
1036CHANTRACE
1037CLOSE
1038CNOTICE
1039CPRIVMSG
1040DIE
1041GET
1042HELP
1043ISON
1044LIST
03a905bd
JT
1045MAP
1046MASKTRACE
1047MODLIST
1048MODLOAD
1049MODRELOAD
1050MODRESTART
1051MODUNLOAD
1052MONITOR
1053NAMES
1054OPER
1055POST
1056PUT
1057RESTART
1058SCAN
1059SET
1060TESTGECOS
1061TESTLINE
1062TESTMASK
1063UHELP
1064UNREJECT
1065USER
1066USERHOST
1067WEBIRC
1068WHO
1069WHOWAS