]> jfr.im git - solanum.git/blame - doc/technical/ts6-protocol.txt
Update MLOCK protocol documentation to match changes in code
[solanum.git] / doc / technical / ts6-protocol.txt
CommitLineData
cdff8b70
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
03204327
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.
cdff8b70
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
aa12f64b
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
13d42555
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).
aa12f64b 62
cdff8b70
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)
4b58bbb2
JT
83+e (ban exception) (capab: EX)
84+I (invite exception) (capab: IE)
cdff8b70
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)
4b58bbb2 93+r (only registered users may join) (only if a services server exists) (capab: SERVICES)
cdff8b70
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
f8933d67
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
cdff8b70
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
13d42555
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
a0ce140e
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.
13d42555
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
cdff8b70
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
aa12f64b
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.
cdff8b70
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
03204327
JT
251Sends a command to matching servers. Propagation is independent of
252understanding the subcommand.
cdff8b70 253
03204327 254Subcommands are listed elsewhere with "encap only".
cdff8b70
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
86aba27c
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
7e7004c4
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
cdff8b70
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
2d042188
JT
370A JOIN is propagated with the new TS of the channel.
371
cdff8b70
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
4b58bbb2 410capab: KNOCK
cdff8b70
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
3cadd0c4
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
cdff8b70
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
d09bb8ae
AC
457MLOCK
458charybdis TS6
459source: services server
73d83e6d 460parameters: channelTS, channel, mode letters
d09bb8ae
AC
461propagation: broadcast (restricted)
462
73d83e6d 463Propagates a channel mode lock change.
d09bb8ae
AC
464
465If the channelTS is greater (newer) than the current TS of the channel, drop
466the message.
467
73d83e6d
SB
468The final parameter is a list of mode letters that may not be changed by local
469users. This applies to setting or unsetting simple modes, and changing or
470removing mode parameters.
d09bb8ae
AC
471
472An MLOCK message with no modes disables the MLOCK, therefore the MLOCK message
473always contains the literal MLOCK for simplicity.
474
cdff8b70
JT
475MODE
4761.
477source: user
478parameters: client, umode changes
479propagation: broadcast
480
481Propagates a user mode change. The client parameter must refer to the same user
482as the source.
483
484Not all umodes are propagated to other servers.
485
4862.
487source: any
488parameters: channel, cmode changes, opt. cmode parameters...
489
490Propagates a channel mode change.
491
492This is deprecated because the channelTS is not included. If it is received,
493it should be propagated as TMODE.
494
495MOTD
496source: user
497parameters: hunted
498
499Remote MOTD request.
500
501NICK
5021.
503source: user
504parameters: new nickname, new nickTS
505propagation: broadcast
506
507Propagates a nick change.
508
5092.
510source: server
511parameters: nickname, hopcount, nickTS, umodes, username, hostname, server, gecos
512
513Historic TS5 user introduction. The user is on the server indicated by the
514server parameter; the source server is meaningless (local link).
515
516NICKDELAY
517charybdis TS6
518encap only
519encap target: *
520source: services server
521parameters: duration, nickname
522
523If duration is greater than 0, makes the given nickname unavailable for that
524time.
525
526If duration is 0, removes a nick delay entry for the given nickname.
527
528There may or may not be a client with the given nickname; this does not affect
529the operation.
530
531NOTICE
532source: any
533parameters: msgtarget, message
534
535As PRIVMSG, except NOTICE messages are sent out, server sources are permitted
536and most error messages are suppressed.
537
0749b751
JT
538Servers may not send '$$', '$#' and opers@server notices. Older servers may
539not allow servers to send to specific statuses on a channel.
540
cdff8b70
JT
541OPERSPY
542encap only
543encap target: *
544source: user
545parameters: command name, parameters
546
547Reports operspy usage.
548
549OPERWALL
550source: user
551parameters: message
552propagation: broadcast
553
554Sends a message to operators (with umode +z set).
555
556PART
557source: user
558parameters: comma separated channel list, message
559
560Parts the source user from the given channels.
561
562PASS
563source: unregistered server
564parameters: password, 'TS', TS version, SID
565
566Sends the server link password, TS version and SID.
567
568PING
569source: any
aa12f64b 570parameters: origin, opt. destination server
cdff8b70 571
aa12f64b
JT
572Sends a PING to the destination server, which will reply with a PONG. If the
573destination server parameter is not present, the server receiving the message
574must reply.
cdff8b70 575
aa12f64b
JT
576The origin field is not used in the server protocol. It is sent as the name
577(not UID/SID) of the source.
cdff8b70
JT
578
579Remote PINGs are used for end-of-burst detection, therefore all servers must
580implement them.
581
582PONG
583source: server
584parameters: origin, destination
585
586Routes a PONG back to the destination that originally sent the PING.
587
588PRIVMSG
589source: user
590parameters: msgtarget, message
591
592Sends a normal message (PRIVMSG) to the given target.
593
594The target can be:
595- a client
596 propagation: one-to-one
597- a channel name
598 propagation: all servers with -D users on the channel
599 (cmode +m/+n should be checked everywhere, bans should not be checked
600 remotely)
601- a status character ('@'/'+') followed by a channel name, to send to users
602 with that status or higher only.
1ba5ea0f 603 capab: CHW
cdff8b70 604 propagation: all servers with -D users with appropriate status
c4d2d014
JT
605- '=' followed by a channel name, to send to chanops only, for cmode +z.
606 capab: CHW and EOPMOD
607 propagation: all servers with -D chanops
cdff8b70
JT
608- a user@server message, to send to users on a specific server. The exact
609 meaning of the part before the '@' is not prescribed, except that "opers"
610 allows IRC operators to send to all IRC operators on the server in an
611 unspecified format.
612 propagation: one-to-one
613- a message to all users on server names matching a mask ('$$' followed by mask)
614 propagation: broadcast
0749b751 615 Only allowed to IRC operators.
cdff8b70
JT
616- a message to all users with hostnames matching a mask ('$#' followed by mask).
617 Note that this is often implemented poorly.
618 propagation: broadcast
0749b751
JT
619 Only allowed to IRC operators.
620
621In charybdis TS6, services may send to any channel and to statuses on any
622channel.
cdff8b70
JT
623
624PRIVS
625charybdis TS6
626encap only
627encap target: single server
628source: oper
629parameters: client
630
631Remote PRIVS information request.
632
633QUIT
634source: user
635parameters: comment
636
637Propagates quitting of a client. No QUIT should be sent for a client that
638has been removed as result of a KILL message.
639
640REALHOST
641charybdis TS6
642encap only
643encap target: *
644source: user
645parameters: real hostname
646
647In a burst, propagates the real host of a dynamically-spoofed user.
648
649REHASH
650charybdis TS6
651encap only
652source: user
653parameters: opt. rehash type
654
655Remote REHASH request. If the rehash type is omitted, it is equivalent to
656a regular /rehash, otherwise it is equivalent to /rehash <rehash type>.
657
658RESV
6591.
660encap only
661source: user
662parameters: duration, mask, reason
663
664Sets a RESV, making a nickname mask or exact channel unavailable.
665
6662.
667capab: CLUSTER
668source: user
669parameters: target server mask, duration, mask, reason
670
671As form 1, deprecated.
672
673RSFNC
674encap only
675capab: RSFNC
676encap target: single server
677source: services server
678parameters: target user, new nickname, old nickTS, new nickTS
679
680Forces a nickname change and propagates it.
681
682The command is ignored if the nick TS of the user is not equal to the old
683nickTS parameter. If the new nickname already exists (and is not the target
684user), it is killed first.
685
686SASL
687charybdis TS6
688encap only
6891.
690encap target: *
691source: server
692parameters: source uid, '*', 'S', sasl mechanism name
693
694Requests that a SASL agent (a service) initiate the authentication process.
695The source uid is that of an unregistered client. This is why it is not sent
696as the prefix.
697
6982.
699encap target: single server
700source: server
701parameters: source uid, target uid, mode, data
702
703Part of a SASL authentication exchange. The mode is 'C' to send some data
704(base64 encoded), or 'S' to end the exchange (data indicates type of
705termination: 'A' for abort, 'F' for authentication failure, 'S' for
706authentication success).
707
708SAVE
709capab: SAVE
710source: server
711propagation: broadcast
712parameters: target uid, TS
713
714Resolve a nick collision by changing a nickname to the UID.
715
716The server should verify that the UID belongs to a registered user, the user
717does not already have their UID as their nick and the TS matches the user's
718nickTS. If not, drop the message.
719
720SAVE should be propagated as a regular NICK change to links without SAVE capab.
721present.
722
723SERVER
7241.
725source: unregistered server
726parameters: server name, hopcount, server description
727
728Registers the connection as a server. PASS and CAPAB must have been sent
729before, SVINFO should be sent afterwards.
730
731If there is no such server configured or authentication failed, the connection
732should be dropped.
733
734This is propagated as a SID message.
735
7362.
737source: server
738propagation: broadcast
739parameters: server name, hopcount, server description
740
741Introduces a new TS5 server, directly connected to the source of this command.
742This is only used for jupes as TS5 servers may do little else than existing.
743
744SID
745source: server
746propagation: broadcast
747parameters: server name, hopcount, sid, server description
748
749Introduces a new server, directly connected to the source of this command.
750
751SIGNON
752source: user
753propagation: broadcast
754parameters: new nickname, new username, new visible hostname, new nickTS, new login name
755
756Broadcasts a change of several user parameters at once.
757
758Currently only sent after an SVSLOGIN.
759
760SJOIN
761source: server
762propagation: broadcast
763parameters: channelTS, simple modes, opt. mode parameters..., nicklist
764
765Broadcasts a channel creation or bursts a channel.
766
767The nicklist consists of users joining the channel, with status prefixes for
768their status ('@+', '@', '+' or ''), for example:
769'@+1JJAAAAAB +2JJAAAA4C 1JJAAAADS'. All users must be behind the source server
770so it is not possible to use this message to force users to join a channel.
771
772The interpretation depends on the channelTS and the current TS of the channel.
773If either is 0, set the channel's TS to 0 and accept all modes. Otherwise, if
774the incoming channelTS is greater (newer), ignore the incoming simple modes
775and statuses and join and propagate just the users. If the incoming channelTS
776is lower (older), wipe all modes and change the TS, notifying local users of
777this but not servers (invites may be cleared). In the latter case, kick on
778split riding may happen: if the key (+k) differs or the incoming simple modes
779include +i, kick all local users, sending KICK messages to servers.
780
2d042188
JT
781An SJOIN is propagated with the new TS and modes of the channel. The statuses
782are propagated if and only if they were accepted.
783
cdff8b70
JT
784SJOIN must be used to propagate channel creation and in netbursts. For regular
785users joining channels, JOIN must be used. Pseudoservers may use SJOIN to join
786a user with ops.
787
788SNOTE
789charybdis TS6
790encap only
791source: server
792parameters: snomask letter, text
793
794Sends the text as a server notice from the source server to opers with the
795given snomask set.
796
797SQUIT
798parameters: target server, comment
799
800Removes the target server and all servers and users behind it from the network.
801
802If the target server is the receiving server or the local link this came from,
803this is an announcement that the link is being closed.
804
805Otherwise, if the target server is locally connected, the server should send
806a WALLOPS announcing the SQUIT.
807
808STATS
809source: user
810parameters: stats letter, hunted
811
812Remote STATS request. Privileges are checked on the server executing the
813actual request.
814
815SU
816encap only
817encap target: *
818source: services server
819parameters: target user, new login name (optional)
820
821If the new login name is not present or empty, mark the target user as not
822logged in, otherwise mark the target user as logged in as the given account.
823
824SVINFO
825source: server
826propagation: none
827parameters: current TS version, minimum TS version, '0', current time
828
829Verifies TS protocol compatibility and clock. If anything is not in order,
830the link is dropped.
831
832The current TS version is the highest version supported by the source server
833and the minimum TS version is the lowest version supported.
834
835The current time is sent as a TS in the usual way.
836
837SVSLOGIN
838charybdis TS6
839encap only
840encap target: single server
841source: services server
842parameters: target, new nick, new username, new visible hostname, new login name
843
844Sent after successful SASL authentication.
845
846The target is a UID, typically an unregistered one.
847
848Any of the "new" parameters can be '*' to leave the corresponding field
849unchanged. The new login name can be '0' to log the user out.
850
851If the UID is registered on the network, a SIGNON with the changes will be
852broadcast, otherwise the changes will be stored, to be used when registration
853completes.
854
855TB
3e0bb80a 856capab: TB
cdff8b70
JT
857source: server
858propagation: broadcast
3e0bb80a
JT
859parameters: channel, topicTS, opt. topic setter, topic
860
861Propagates a channel topic as part of a burst.
862
863If the channel had no topic yet or the topicTS in the message is older than
864the topicTS of the current topic on the channel and the topics differ, set
865the topic with topicTS and topic setter, and propagate the message. Otherwise
866ignore the message and do not propagate it.
867
868If the topic setter is not present, use a server name instead.
cdff8b70
JT
869
870TIME
871source: user
872parameters: hunted
873
874Remote TIME request.
875
876TMODE
877source: any
878parameters: channelTS, channel, cmode changes, opt. cmode parameters...
879
880Propagates a channel mode change.
881
882If the channelTS is greater (newer) than the current TS of the channel, drop
883the message.
884
885On input, only the limit on parameters per line restricts how many cmode
886parameters can be present. Apart from this, arbitrary modes shall be
887processed. Redundant modes may be dropped. For example, +n-n may be applied and
888propagated as +n-n, -n or (if the channel was already -n) nothing, but not as
889+n.
890
891The parameter for mode -k (removing a key) shall be ignored.
892
893On output, at most ten cmode parameters should be sent; if there are more,
894multiple TMODE messages should be sent.
895
896TOPIC
897source: user
898propagation: broadcast
3e0bb80a 899parameters: channel, topic
cdff8b70
JT
900
901Propagates a channel topic change. The server may verify that the source has
902ops in the channel.
903
3e0bb80a
JT
904The topicTS shall be set to the current time and the topic setter shall be
905set indicating the source user. Note that this means that the topicTS of a
906topic set with TOPIC is not necessarily consistent across the network.
907
cdff8b70
JT
908TRACE
909source: user
9101.
911parameters: hunted
912
913Performs a trace to the target, sending 200 numerics from each server passing
914the message on. The target server sends a description of the target followed
915by a 262 numeric.
916
917TRACE, STATS l and STATS L are the only commands using hunt_server that use the
918hunted parameter for more than just determining which server the command
919should be executed on.
920
9212.
922parameters: target name, hunted
923
924Executes a trace command on the target server. No 200 numerics are sent.
925The target name is a name, not a UID, and should be on the target server.
926
927UID
928source: server
929propagation: broadcast
930parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, gecos
931propagation: broadcast
932
933Introduces a client. The client is on the source server of this command.
934
935Nick TS rules apply.
936
937UNDLINE
938charybdis TS6
939encap only
940source: user
941parameters: mask
942
943Removes a D:line (IP ban checked directly after accepting connection).
944
945The mask must be an IP address or CIDR mask.
946
947UNKLINE
9481.
949encap only
950source: user
951parameters: user mask, host mask
952
953Removes a K:line (ban on user@host).
954
9552.
956capab: UNKLN
957source: user
958parameters: target server mask, user mask, host mask
959
960As form 1, deprecated.
961
962UNRESV
9631.
964encap only
965source: user
966parameters: mask
967
968Removes a RESV.
969
9702.
971capab: CLUSTER
972source: user
973parameters: target server mask, mask
974
975As form 1, deprecated.
976
977UNXLINE
9781.
979encap only
980source: user
981parameters: mask
982
983Removes an X:line (ban on realname).
984
9852.
986capab: CLUSTER
987source: user
988parameters: target server mask, mask
989
990As form 1, deprecated.
991
992USERS
993source: user
994parameters: hunted
995
996Remote USERS request.
997
998VERSION
999source: any
1000parameters: hunted
1001
1002Remote VERSION request.
1003
1004WALLOPS
10051.
1006source: user
1007parameters: message
1008propagation: broadcast
1009
1010In efnet TS6, sends a message to operators (with umode +z set). This is a
1011deprecated equivalent to OPERWALL.
1012
1013In charybdis TS6, sends a message to local users with umode +w set (or possibly
1014another indication that WALLOPS messages should be sent), including non-opers.
1015
10162.
1017source: server
1018parameters: message
1019propagation: broadcast
1020
1021Sends a message to local users with umode +w set (or possibly another
1022indication that WALLOPS messages should be sent).
1023
1024In efnet TS6 this may include non-opers, in charybdis TS6 this may only be
1025sent to opers.
1026
1027WHOIS
1028source: user
1029parameters: hunted, target nick
1030
1031Remote WHOIS request.
1032
1033XLINE
10341.
1035encap only
1036source: user
1037parameters: duration, mask, reason
1038
1039Sets an X:line (ban on realname).
1040
10412.
1042capab: CLUSTER
1043source: user
1044parameters: target server mask, duration, mask, reason
1045
1046As form 1, deprecated.
1047
1048Local only commands (charybdis 3.1):
1049
1050ACCEPT
1051AUTHENTICATE
1052CAP
1053CHALLENGE
1054CHANTRACE
1055CLOSE
1056CNOTICE
1057CPRIVMSG
1058DIE
1059GET
1060HELP
1061ISON
1062LIST
cdff8b70
JT
1063MAP
1064MASKTRACE
1065MODLIST
1066MODLOAD
1067MODRELOAD
1068MODRESTART
1069MODUNLOAD
1070MONITOR
1071NAMES
1072OPER
1073POST
1074PUT
1075RESTART
1076SCAN
1077SET
1078TESTGECOS
1079TESTLINE
1080TESTMASK
1081UHELP
1082UNREJECT
1083USER
1084USERHOST
1085WEBIRC
1086WHO
1087WHOWAS