Author: Bleep <tomh@inxpress.net>
[ircu2.10.12-pk.git] / doc / rfc1459.unet
1 Network Working Group                                      J. Oikarinen
2 Request for Comments: 1459                                      D. Reed
3                                                                May 1993
4
5
6                       Internet Relay Chat Protocol
7
8 Undernet Specific Annotations and Changes
9    This document exists here in order to attempt to describe the existing
10    protocol that is currently in use on the Undernet IRC Network. Since
11    the original standard was released, many networks have made
12    significant changes and enhancements to the protocol described in the
13    original version of this document. This version of the standard should
14    be updated by the current maintainers of the Undernet server software
15    distribution as changes are made that affect the protocol. Please be
16    aware that some sections may be out of date.
17
18 Status of This Memo
19
20    This memo defines an Experimental Protocol for the Internet
21    community.  Discussion and suggestions for improvement are requested.
22    Please refer to the current edition of the "IAB Official Protocol
23    Standards" for the standardization state and status of this protocol.
24    Distribution of this memo is unlimited.
25
26 Abstract
27
28    The IRC protocol was developed over the last 4 years since it was
29    first implemented as a means for users on a BBS to chat amongst
30    themselves.  Now it supports a world-wide network of servers and
31    clients, and is stringing to cope with growth. Over the past 2 years,
32    the average number of users connected to the main IRC network has
33    grown by a factor of 10.
34
35    The IRC protocol is a text-based protocol, with the simplest client
36    being any socket program capable of connecting to the server.
37
38 Table of Contents
39
40    1.  INTRODUCTION ...............................................    4
41       1.1  Servers ................................................    4
42       1.2  Clients ................................................    5
43          1.2.1 Operators ..........................................    5
44       1.3 Channels ................................................    5
45       1.3.1  Channel Operators ....................................    6
46    2. THE IRC SPECIFICATION .......................................    7
47       2.1 Overview ................................................    7
48       2.2 Character codes .........................................    7
49       2.3 Messages ................................................    7
50          2.3.1  Message format in 'pseudo' BNF ....................    8
51       2.4 Numeric replies .........................................   10
52    3. IRC Concepts ................................................   10
53       3.1 One-to-one communication ................................   10
54       3.2 One-to-many .............................................   11
55          3.2.1 To a list ..........................................   11
56          3.2.2 To a group (channel) ...............................   11
57          3.2.3 To a host/server mask ..............................   12
58       3.3 One to all ..............................................   12
59
60
61
62 Oikarinen & Reed                                                [Page 1]
63 \f
64 RFC 1459              Internet Relay Chat Protocol              May 1993
65
66
67          3.3.1 Client to Client ...................................   12
68          3.3.2 Clients to Server ..................................   12
69          3.3.3 Server to Server ...................................   12
70    4. MESSAGE DETAILS .............................................   13
71       4.1 Connection Registration .................................   13
72          4.1.1 Password message ...................................   14
73          4.1.2 Nickname message ...................................   14
74          4.1.3 User message .......................................   15
75          4.1.4 Server message .....................................   16
76          4.1.5 Operator message ...................................   17
77          4.1.6 Quit message .......................................   17
78          4.1.7 Server Quit message ................................   18
79       4.2 Channel operations ......................................   19
80          4.2.1 Join message .......................................   19
81          4.2.2 Part message .......................................   20
82          4.2.3 Mode message .......................................   21
83             4.2.3.1 Channel modes .................................   21
84             4.2.3.2 User modes ....................................   22
85          4.2.4 Topic message ......................................   23
86          4.2.5 Names message ......................................   24
87          4.2.6 List message .......................................   24
88          4.2.7 Invite message .....................................   25
89          4.2.8 Kick message .......................................   25
90       4.3 Server queries and commands .............................   26
91          4.3.1 Version message ....................................   26
92          4.3.2 Stats message ......................................   27
93          4.3.3 Links message ......................................   28
94          4.3.4 Time message .......................................   29
95          4.3.5 Connect message ....................................   29
96          4.3.6 Trace message ......................................   30
97          4.3.7 Admin message ......................................   31
98          4.3.8 Info message .......................................   31
99       4.4 Sending messages ........................................   32
100          4.4.1 Private messages ...................................   32
101          4.4.2 Notice messages ....................................   33
102       4.5 User-based queries ......................................   33
103          4.5.1 Who query ..........................................   33
104          4.5.2 Whois query ........................................   34
105          4.5.3 Whowas message .....................................   35
106       4.6 Miscellaneous messages ..................................   35
107          4.6.1 Kill message .......................................   36
108          4.6.2 Ping message .......................................   37
109          4.6.3 Pong message .......................................   37
110          4.6.4 Error message ......................................   38
111    5. OPTIONAL MESSAGES ...........................................   38
112       5.1 Away message ............................................   38
113       5.2 Rehash command ..........................................   39
114       5.3 Restart command .........................................   39
115
116
117
118 Oikarinen & Reed                                                [Page 2]
119 \f
120 RFC 1459              Internet Relay Chat Protocol              May 1993
121
122
123       5.4 Summon message ..........................................   40
124       5.5 Users message ...........................................   40
125       5.6 Operwall command ........................................   41
126       5.7 Userhost message ........................................   42
127       5.8 Ison message ............................................   42
128    6. REPLIES .....................................................   43
129       6.1 Error Replies ...........................................   43
130       6.2 Command responses .......................................   48
131       6.3 Reserved numerics .......................................   56
132    7. Client and server authentication ............................   56
133    8. Current Implementations Details .............................   56
134       8.1 Network protocol: TCP ...................................   57
135          8.1.1 Support of Unix sockets ............................   57
136       8.2 Command Parsing .........................................   57
137       8.3 Message delivery ........................................   57
138       8.4 Connection 'Liveness' ...................................   58
139       8.5 Establishing a server-client connection .................   58
140       8.6 Establishing a server-server connection .................   58
141          8.6.1 State information exchange when connecting .........   59
142       8.7 Terminating server-client connections ...................   59
143       8.8 Terminating server-server connections ...................   59
144       8.9 Tracking nickname changes ...............................   60
145       8.10 Flood control of clients ...............................   60
146       8.11 Non-blocking lookups ...................................   61
147          8.11.1 Hostname (DNS) lookups ............................   61
148          8.11.2 Username (Ident) lookups ..........................   61
149       8.12 Configuration file .....................................   61
150          8.12.1 Allowing clients to connect .......................   62
151          8.12.2 Operators .........................................   62
152          8.12.3 Allowing servers to connect .......................   62
153          8.12.4 Administrivia .....................................   63
154       8.13 Channel membership .....................................   63
155    9. Current problems ............................................   63
156       9.1 Scalability .............................................   63
157       9.2 Labels ..................................................   63
158          9.2.1 Nicknames ..........................................   63
159          9.2.2 Channels ...........................................   64
160          9.2.3 Servers ............................................   64
161       9.3 Algorithms ..............................................   64
162    10. Support and availability ...................................   64
163    11. Security Considerations ....................................   65
164    12. Authors' Addresses .........................................   65
165
166
167
168
169
170
171
172
173
174 Oikarinen & Reed                                                [Page 3]
175 \f
176 RFC 1459              Internet Relay Chat Protocol              May 1993
177
178
179 1.  INTRODUCTION
180
181    The IRC (Internet Relay Chat) protocol has been designed over a
182    number of years for use with text based conferencing.  This document
183    describes the current IRC protocol.
184
185    The IRC protocol has been developed on systems using the TCP/IP
186    network protocol, although there is no requirement that this remain
187    the only sphere in which it operates.
188
189    IRC itself is a teleconferencing system, which (through the use of
190    the client-server model) is well-suited to running on many machines
191    in a distributed fashion.  A typical setup involves a single process
192    (the server) forming a central point for clients (or other servers)
193    to connect to, performing the required message delivery/multiplexing
194    and other functions.
195
196 1.1 Servers
197
198    The server forms the backbone of IRC, providing a point to which
199    clients may connect to to talk to each other, and a point for other
200    servers to connect to, forming an IRC network.  The only network
201    configuration allowed for IRC servers is that of a spanning tree [see
202    Fig. 1] where each server acts as a central node for the rest of the
203    net it sees.
204
205
206                            [ Server 15 ]  [ Server 13 ] [ Server 14]
207                                  /                \         /
208                                 /                  \       /
209         [ Server 11 ] ------ [ Server 1 ]       [ Server 12]
210                               /        \          /
211                              /          \        /
212                   [ Server 2 ]          [ Server 3 ]
213                     /       \                      \
214                    /         \                      \
215            [ Server 4 ]    [ Server 5 ]         [ Server 6 ]
216             /    |    \                           /
217            /     |     \                         /
218           /      |      \____                   /
219          /       |           \                 /
220  [ Server 7 ] [ Server 8 ] [ Server 9 ]   [ Server 10 ]
221
222                                   :
223                                [ etc. ]
224                                   :
225
226                  [ Fig. 1. Format of IRC server network ]
227
228
229
230 Oikarinen & Reed                                                [Page 4]
231 \f
232 RFC 1459              Internet Relay Chat Protocol              May 1993
233
234
235 1.2 Clients
236
237    A client is anything connecting to a server that is not another
238    server.  Each client is distinguished from other clients by a unique
239    nickname having a maximum length of nine (9) characters.  See the
240    protocol grammar rules for what may and may not be used in a
241    nickname.  In addition to the nickname, all servers must have the
242    following information about all clients: the real name of the host
243    that the client is running on, the username of the client on that
244    host, and the server to which the client is connected.
245
246 1.2.1 Operators
247
248    To allow a reasonable amount of order to be kept within the IRC
249    network, a special class of clients (operators) is allowed to perform
250    general maintenance functions on the network.  Although the powers
251    granted to an operator can be considered as 'dangerous', they are
252    nonetheless required.  Operators should be able to perform basic
253    network tasks such as disconnecting and reconnecting servers as
254    needed to prevent long-term use of bad network routing.  In
255    recognition of this need, the protocol discussed herein provides for
256    operators only to be able to perform such functions.  See sections
257    4.1.7 (SQUIT) and 4.3.5 (CONNECT).
258
259    A more controversial power of operators is the ability  to  remove  a
260    user  from  the connected network by 'force', i.e. operators are able
261    to close the connection between any client and server.   The
262    justification for  this  is delicate since its abuse is both
263    destructive and annoying.  For further details on this type of
264    action, see section 4.6.1 (KILL).
265
266 1.3 Channels
267
268    A channel is a named group of one or more clients which will all
269    receive messages addressed to that channel.  The channel is created
270    implicitly when the first client joins it, and the channel ceases to
271    exist when the last client leaves it.  While channel exists, any
272    client can reference the channel using the name of the channel.
273
274    Channels names are strings (beginning with a '&' or '#' character) of
275    length up to 200 characters.  Apart from the the requirement that the
276    first character being either '&' or '#'; the only restriction on a
277    channel name is that it may not contain any spaces (' '), a control G
278    (^G or ASCII 7), or a comma (',' which is used as a list item
279    separator by the protocol).
280
281    There are two types of channels allowed by this protocol.  One is a
282    distributed channel which is known to all the servers that are
283
284
285
286 Oikarinen & Reed                                                [Page 5]
287 \f
288 RFC 1459              Internet Relay Chat Protocol              May 1993
289
290
291    connected to the network. These channels are marked by the first
292    character being a only clients on the server where it exists may join
293    it.  These are distinguished by a leading '&' character.  On top of
294    these two types, there are the various channel modes available to
295    alter the characteristics of individual channels.  See section 4.2.3
296    (MODE command) for more details on this.
297
298    To create a new channel or become part of an existing channel, a user
299    is required to JOIN the channel.  If the channel doesn't exist prior
300    to joining, the channel is created and the creating user becomes a
301    channel operator.  If the channel already exists, whether or not your
302    request to JOIN that channel is honoured depends on the current modes
303    of the channel. For example, if the channel is invite-only, (+i),
304    then you may only join if invited.  As part of the protocol, a user
305    may be a part of several channels at once, but a limit of ten (10)
306    channels is recommended as being ample for both experienced and
307    novice users.  See section 8.13 for more information on this.
308
309    If the IRC network becomes disjoint because of a split between two
310    servers, the channel on each side is only composed of those clients
311    which are connected to servers on the respective sides of the split,
312    possibly ceasing to exist on one side of the split.  When the split
313    is healed, the connecting servers announce to each other who they
314    think is in each channel and the mode of that channel.  If the
315    channel exists on both sides, the JOINs and MODEs are interpreted in
316    an inclusive manner so that both sides of the new connection will
317    agree about which clients are in the channel and what modes the
318    channel has.
319
320 1.3.1 Channel Operators
321
322    The channel operator (also referred to as a "chop" or "chanop") on a
323    given channel is considered to 'own' that channel.  In recognition of
324    this status, channel operators are endowed with certain powers which
325    enable them to keep control and some sort of sanity in their channel.
326    As an owner of a channel, a channel operator is not required to have
327    reasons for their actions, although if their actions are generally
328    antisocial or otherwise abusive, it might be reasonable to ask an IRC
329    operator to intervene, or for the usersjust leave and go elsewhere
330    and form their own channel.
331
332    The commands which may only be used by channel operators are:
333
334         KICK    - Eject a client from the channel
335         MODE    - Change the channel's mode
336         INVITE  - Invite a client to an invite-only channel (mode +i)
337         TOPIC   - Change the channel topic in a mode +t channel
338
339
340
341
342 Oikarinen & Reed                                                [Page 6]
343 \f
344 RFC 1459              Internet Relay Chat Protocol              May 1993
345
346
347    A channel operator is identified by the '@' symbol next to their
348    nickname whenever it is associated with a channel (ie replies to the
349    NAMES, WHO and WHOIS commands).
350
351 2. The IRC Specification
352
353 2.1 Overview
354
355    The protocol as described herein is for use both with server to
356    server and client to server connections.  There are, however, more
357    restrictions on client connections (which are considered to be
358    untrustworthy) than on server connections.
359
360 2.2 Character codes
361
362    No specific character set is specified. The protocol is based on a a
363    set of codes which are composed of eight (8) bits, making up an
364    octet.  Each message may be composed of any number of these octets;
365    however, some octet values are used for control codes which act as
366    message delimiters.
367
368    Regardless of being an 8-bit protocol, the delimiters and keywords
369    are such that protocol is mostly usable from USASCII terminal and a
370    telnet connection.
371
372    Because of IRC's scandanavian origin, the characters {}| are
373    considered to be the lower case equivalents of the characters []\,
374    respectively. This is a critical issue when determining the
375    equivalence of two nicknames.
376
377 2.3 Messages
378
379    Servers and clients send eachother messages which may or may not
380    generate a reply.  If the message contains a valid command, as
381    described in later sections, the client should expect a reply as
382    specified but it is not advised to wait forever for the reply; client
383    to server and server to server communication is essentially
384    asynchronous in nature.
385
386    Each IRC message may consist of up to three main parts: the prefix
387    (optional), the command, and the command parameters (of which there
388    may be up to 15).  The prefix, command, and all parameters are
389    separated by one (or more) ASCII space character(s) (0x20).
390
391    The presence of a prefix is indicated with a single leading ASCII
392    colon character (':', 0x3b), which must be the first character of the
393    message itself.  There must be no gap (whitespace) between the colon
394    and the prefix.  The prefix is used by servers to indicate the true
395
396
397
398 Oikarinen & Reed                                                [Page 7]
399 \f
400 RFC 1459              Internet Relay Chat Protocol              May 1993
401
402
403    origin of the message.  If the prefix is missing from the message, it
404    is assumed to have originated from the connection from which it was
405    received.  Clients should not use prefix when sending a message from
406    themselves; if they use a prefix, the only valid prefix is the
407    registered nickname associated with the client.  If the source
408    identified by the prefix cannot be found from the server's internal
409    database, or if the source is registered from a different link than
410    from which the message arrived, the server must ignore the message
411    silently.
412
413    The command must either be a valid IRC command or a three (3) digit
414    number represented in ASCII text.
415
416    IRC messages are always lines of characters terminated with a CR-LF
417    (Carriage Return - Line Feed) pair, and these messages shall not
418    exceed 512 characters in length, counting all characters including
419    the trailing CR-LF. Thus, there are 510 characters maximum allowed
420    for the command and its parameters.  There is no provision for
421    continuation message lines.  See section 7 for more details about
422    current implementations.
423
424 2.3.1 Message format in 'pseudo' BNF
425
426    The protocol messages must be extracted from the contiguous stream of
427    octets.  The current solution is to designate two characters, CR and
428    LF, as message separators.   Empty  messages  are  silently  ignored,
429    which permits  use  of  the  sequence  CR-LF  between  messages
430    without extra problems.
431
432    The extracted message is parsed into the components <prefix>,
433    <command> and list of parameters matched either by <middle> or
434    <trailing> components.
435
436    The BNF representation for this is:
437
438
439 <server_message> ::= <numeric> <command> <params> <crlf>
440 <message>  ::= [':' <prefix> <SPACE> ] <command> <params> <crlf>
441 <prefix>   ::= <servername> | <nick> [ '!' <user> ] [ '@' <host> ]
442 <command>  ::= <letter> { <letter> } | <number> <number> <number>
443 <SPACE>    ::= ' ' { ' ' }
444 <params>   ::= <SPACE> [ ':' <trailing> | <middle> <params> ]
445 <numeric>  ::= <numeric> { <letter> | <number> | '[' | ']' }
446
447 <middle>   ::= <Any *non-empty* sequence of octets not including SPACE
448                or NUL or CR or LF, the first of which may not be ':'>
449 <trailing> ::= <Any, possibly *empty*, sequence of octets not including
450                  NUL or CR or LF>
451
452 <crlf>     ::= CR LF
453
454
455
456 Oikarinen & Reed                                                [Page 8]
457 \f
458 RFC 1459              Internet Relay Chat Protocol              May 1993
459
460
461 NOTES:
462
463   1)    <SPACE> is consists only of SPACE character(s) (0x20).
464         Specially notice that TABULATION, and all other control
465         characters are considered NON-WHITE-SPACE.
466
467   2)    After extracting the parameter list, all parameters are equal,
468         whether matched by <middle> or <trailing>. <Trailing> is just
469         a syntactic trick to allow SPACE within parameter.
470
471   3)    The fact that CR and LF cannot appear in parameter strings is
472         just artifact of the message framing. This might change later.
473
474   4)    The NUL character is not special in message framing, and
475         basically could end up inside a parameter, but as it would
476         cause extra complexities in normal C string handling. Therefore
477         NUL is not allowed within messages.
478
479   5)    The last parameter may be an empty string.
480
481   6)    Use of the extended prefix (['!' <user> ] ['@' <host> ]) must
482         not be used in server to server communications and is only
483         intended for server to client messages in order to provide
484         clients with more useful information about who a message is
485         from without the need for additional queries.
486
487    Most protocol messages specify additional semantics and syntax for
488    the extracted parameter strings dictated by their position in the
489    list.  For example, many server commands will assume that the first
490    parameter after the command is the list of targets, which can be
491    described with:
492
493    <target>     ::= <to> [ "," <target> ]
494    <to>         ::= <channel> | <user> '@' <servername> | <nick> | <mask>
495    <channel>    ::= ('#' | '&' | '+') <chstring>
496    <servername> ::= <host>
497    <host>       ::= see RFC 952 [DNS:4] for details on allowed hostnames
498    <nick>       ::= <letter> { <letter> | <number> | <special> }
499    <mask>       ::= $(<servername> | @<hostname>)
500    <chstring>   ::= <any 8bit code except SPACE, BELL, NUL, CR, LF and
501                      comma (',')>
502
503    Other parameter syntaxes are:
504
505    <user>       ::= <nonwhite> { <nonwhite> }
506    <letter>     ::= 'a' ... 'z' | 'A' ... 'Z'
507    <number>     ::= '0' ... '9'
508    <special>    ::= '-' | '[' | ']' | '\' | '`' | '^' | '{' | '}'
509
510
511
512 Oikarinen & Reed                                                [Page 9]
513 \f
514 RFC 1459              Internet Relay Chat Protocol              May 1993
515
516
517    <nonwhite>   ::= <any 8bit code except SPACE (0x20), NUL (0x0), CR
518                      (0xd), and LF (0xa)>
519
520 2.4 Numeric replies
521
522    Most of the messages sent to the server generate a reply of some
523    sort.  The most common reply is the numeric reply, used for both
524    errors and normal replies.  The numeric reply must be sent as one
525    message consisting of the sender prefix, the three digit numeric, and
526    the target of the reply.  A numeric reply is not allowed to originate
527    from a client; any such messages received by a server are silently
528    dropped. In all other respects, a numeric reply is just like a normal
529    message, except that the keyword is made up of 3 numeric digits
530    rather than a string of letters.  A list of different replies is
531    supplied in section 6.
532
533 3. IRC Concepts.
534
535    This section is devoted to describing the actual concepts behind  the
536    organization  of  the  IRC  protocol and how the current
537    implementations deliver different classes of messages.
538
539
540
541                           1--\
542                               A        D---4
543                           2--/ \      /
544                                 B----C
545                                /      \
546                               3        E
547
548    Servers: A, B, C, D, E         Clients: 1, 2, 3, 4
549
550                     [ Fig. 2. Sample small IRC network ]
551
552 3.1 One-to-one communication
553
554    Communication on a one-to-one basis is usually only performed by
555    clients, since most server-server traffic is not a result of servers
556    talking only to each other.  To provide a secure means for clients to
557    talk to each other, it is required that all servers be able to send a
558    message in exactly one direction along the spanning tree in order to
559    reach any client.  The path of a message being delivered is the
560    shortest path between any two points on the spanning tree.
561
562    The following examples all refer to Figure 2 above.
563
564
565
566
567
568 Oikarinen & Reed                                               [Page 10]
569 \f
570 RFC 1459              Internet Relay Chat Protocol              May 1993
571
572
573 Example 1:
574      A message between clients 1 and 2 is only seen by server A, which
575      sends it straight to client 2.
576
577 Example 2:
578      A message between clients 1 and 3 is seen by servers A & B, and
579      client 3.  No other clients or servers are allowed see the message.
580
581 Example 3:
582      A message between clients 2 and 4 is seen by servers A, B, C & D
583      and client 4 only.
584
585 3.2 One-to-many
586
587    The main goal of IRC is to provide a  forum  which  allows  easy  and
588    efficient  conferencing (one to many conversations).  IRC offers
589    several means to achieve this, each serving its own purpose.
590
591 3.2.1 To a list
592
593    The least efficient style of one-to-many conversation is through
594    clients talking to a 'list' of users.  How this is done is almost
595    self explanatory: the client gives a list of destinations to which
596    the message is to be delivered and the server breaks it up and
597    dispatches a separate copy of the message to each given destination.
598    This isn't as efficient as using a group since the destination list
599    is broken up and the dispatch sent without checking to make sure
600    duplicates aren't sent down each path.
601
602 3.2.2 To a group (channel)
603
604    In IRC the channel has a role equivalent to that of the multicast
605    group; their existence is dynamic (coming and going as people join
606    and leave channels) and the actual conversation carried out on a
607    channel is only sent to servers which are supporting users on a given
608    channel.  If there are multiple users on a server in the same
609    channel, the message text is sent only once to that server and then
610    sent to each client on the channel.  This action is then repeated for
611    each client-server combination until the original message has fanned
612    out and reached each member of the channel.
613
614    The following examples all refer to Figure 2.
615
616 Example 4:
617      Any channel with 1 client in it. Messages to the channel go to the
618      server and then nowhere else.
619
620
621
622
623
624 Oikarinen & Reed                                               [Page 11]
625 \f
626 RFC 1459              Internet Relay Chat Protocol              May 1993
627
628
629 Example 5:
630      2 clients in a channel. All messages traverse a path as if they
631      were private messages between the two clients outside a channel.
632
633 Example 6:
634      Clients 1, 2 and 3 in a channel.  All messages to the channel are
635      sent to all clients and only those servers which must be traversed
636      by the message if it were a private message to a single client.  If
637      client 1 sends a message, it goes back to client 2 and then via
638      server B to client 3.
639
640 3.2.3 To a host/server mask
641
642    To provide IRC operators with some mechanism to send  messages  to  a
643    large body of related users, host and server mask messages are
644    provided.  These messages are sent to users whose host or server
645    information  match that  of  the mask.  The messages are only sent to
646    locations where users are, in a fashion similar to that of channels.
647
648 3.3 One-to-all
649
650    The one-to-all type of message is better described as a broadcast
651    message, sent to all clients or servers or both.  On a large network
652    of users and servers, a single message can result in a lot of traffic
653    being sent over the network in an effort to reach all of the desired
654    destinations.
655
656    For some messages, there is no option but to broadcast it to all
657    servers so that the state information held by each server is
658    reasonably consistent between servers.
659
660 3.3.1 Client-to-Client
661
662    There is no class of message which, from a single message, results in
663    a message being sent to every other client.
664
665 3.3.2 Client-to-Server
666
667    Most of the commands which result in a change of state information
668    (such as channel membership, channel mode, user status, etc) must be
669    sent to all servers by default, and this distribution may not be
670    changed by the client.
671
672 3.3.3 Server-to-Server.
673
674    While most messages between servers are distributed to all 'other'
675    servers, this is only required for any message that affects either a
676    user, channel or server.  Since these are the basic items found in
677
678
679
680 Oikarinen & Reed                                               [Page 12]
681 \f
682 RFC 1459              Internet Relay Chat Protocol              May 1993
683
684
685    IRC, nearly all messages originating from a server are broadcast to
686    all other connected servers.
687
688 4. Message details
689
690    On the following pages are descriptions of each message recognized by
691    the IRC server and client.  All commands described in this section
692    must be implemented by any server for this protocol.
693
694    Where the reply ERR_NOSUCHSERVER is listed, it means that the
695    <server> parameter could not be found.  The server must not send any
696    other replies after this for that command.
697
698    The server to which a client is connected is required to parse the
699    complete message, returning any appropriate errors.  If the server
700    encounters a fatal error while parsing a message, an error must be
701    sent back to the client and the parsing terminated.  A fatal error
702    may be considered to be incorrect command, a destination which is
703    otherwise unknown to the server (server, nick or channel names fit
704    this category), not enough parameters or incorrect privileges.
705
706    If a full set of parameters is presented, then each must be checked
707    for validity and appropriate responses sent back to the client.  In
708    the case of messages which use parameter lists using the comma as an
709    item separator, a reply must be sent for each item.
710
711    In the examples below, some messages appear using the full format:
712
713    :Name COMMAND parameter list
714
715    Such examples represent a message from "Name" in transit between
716    servers, where it is essential to include the name of the original
717    sender of the message so remote servers may send back a reply along
718    the correct path.
719
720 4.1 Connection Registration
721
722    The commands described here are used to register a connection with an
723    IRC server as either a user or a server as well as correctly
724    disconnect.
725
726    A "PASS" command is not required for either client or server
727    connection to be registered, but it must precede the server message
728    or the latter of the NICK/USER combination.  It is strongly
729    recommended that all server connections have a password in order to
730    give some level of security to the actual connections.  The
731    recommended order for a client to register is as follows:
732
733
734
735
736 Oikarinen & Reed                                               [Page 13]
737 \f
738 RFC 1459              Internet Relay Chat Protocol              May 1993
739
740
741            1. Pass message
742            2. Nick message
743            3. User message
744
745 4.1.1 Password message
746
747
748       Command: PASS
749    Parameters: <password>
750
751    The PASS command is used to set a 'connection password'.  The
752    password can and must be set before any attempt to register the
753    connection is made.  Currently this requires that clients send a PASS
754    command before sending the NICK/USER combination and servers *must*
755    send a PASS command before any SERVER command.  The password supplied
756    must match the one contained in the C/N lines (for servers) or I
757    lines (for clients).  It is possible to send multiple PASS commands
758    before registering but only the last one sent is used for
759    verification and it may not be changed once registered.  Numeric
760    Replies:
761
762            ERR_NEEDMOREPARAMS              ERR_ALREADYREGISTRED
763
764    Example:
765
766            PASS secretpasswordhere
767
768 4.1.2 Nick message
769
770       Command: NICK
771    Parameters: <nickname> [ <hopcount> ]
772
773    NICK message is used to give user a nickname or change the previous
774    one.  The <hopcount> parameter is only used by servers to indicate
775    how far away a nick is from its home server.  A local connection has
776    a hopcount of 0.  If supplied by a client, it must be ignored.
777
778    If a NICK message arrives at a server which already knows about an
779    identical nickname for another client, a nickname collision occurs.
780    As a result of a nickname collision, all instances of the nickname
781    are removed from the server's database, and a KILL command is issued
782    to remove the nickname from all other server's database. If the NICK
783    message causing the collision was a nickname change, then the
784    original (old) nick must be removed as well.
785
786    If the server recieves an identical NICK from a client which is
787    directly connected, it may issue an ERR_NICKCOLLISION to the local
788    client, drop the NICK command, and not generate any kills.
789
790
791
792 Oikarinen & Reed                                               [Page 14]
793 \f
794 RFC 1459              Internet Relay Chat Protocol              May 1993
795
796
797    Numeric Replies:
798
799            ERR_NONICKNAMEGIVEN             ERR_ERRONEUSNICKNAME
800            ERR_NICKNAMEINUSE               ERR_NICKCOLLISION
801
802    Example:
803
804    NICK Wiz                        ; Introducing new nick "Wiz".
805
806    :WiZ NICK Kilroy                ; WiZ changed his nickname to Kilroy.
807
808 4.1.3 User message
809
810       Command: USER
811    Parameters: <username> <usermode> <snomask> <info>
812
813    The USER message is used at the beginning of connection to specify
814    the username, usermod, snomask and information of a new user. Servers
815    use the NICK command to send all information once USER and NICK have
816    been received from the client. Only after both USER and NICK have been
817    received from a client does a user become registered.
818
819    Undernet does not send USER between servers, NICK is used to send
820    all information about a user. The usermode parameter allows clients to
821    set their initial user mode (see MODE) upon registration, the snomask
822    parameter allows the user to specify a specific set of server notices
823    they wish to receive. If the usermode and snomasks look like host names
824    they are ignored. If a valid ident response is received from the
825    client's host upon connection, the name returned from the ident server
826    is used and username is ignored. 
827  
828    It must be noted that info parameter must be the last parameter,
829    because it may contain space characters and must be prefixed with a
830    colon (':') to make sure this is recognised as such.
831
832    Since it is easy for a client to lie about its username by relying
833    solely on the USER message, the use of an "Identity Server" is
834    recommended.  If the host which a user connects from has such a
835    server enabled the username is set to that as in the reply from the
836    "Identity Server".
837
838    Numeric Replies:
839
840            ERR_NEEDMOREPARAMS              ERR_ALREADYREGISTRED
841
842    Examples:
843
844
845    USER guest tolmoon tolsun :Ronnie Reagan
846
847
848
849 Oikarinen & Reed                                               [Page 15]
850 \f
851 RFC 1459              Internet Relay Chat Protocol              May 1993
852
853
854                                    ; User registering themselves with a
855                                    username of "guest" and real name
856                                    "Ronnie Reagan".
857
858
859    :testnick USER guest tolmoon tolsun :Ronnie Reagan
860                                    ; message between servers with the
861                                    nickname for which the USER command
862                                    belongs to
863
864 4.1.4 Server message
865
866       Command: SERVER
867    Parameters: <servername> <hopcount> <info>
868
869    The server message is used to tell a server that the other end of a
870    new connection is a server. This message is also used to pass server
871    data over whole net.  When a new server is connected to net,
872    information about it be broadcast to the whole network.  <hopcount>
873    is used to give all servers some internal information on how far away
874    all servers are.  With a full server list, it would be possible to
875    construct a map of the entire server tree, but hostmasks prevent this
876    from being done.
877
878    The SERVER message must only be accepted from either (a) a connection
879    which is yet to be registered and is attempting to register as a
880    server, or (b) an existing connection to another server, in  which
881    case the SERVER message is introducing a new server behind that
882    server.
883
884    Most errors that occur with the receipt of a SERVER command result in
885    the connection being terminated by the destination host (target
886    SERVER).  Error replies are usually sent using the "ERROR" command
887    rather than the numeric since the ERROR command has several useful
888    properties which make it useful here.
889
890    If a SERVER message is parsed and attempts to introduce a server
891    which is already known to the receiving server, the connection from
892    which that message must be closed (following the correct procedures),
893    since a duplicate route to a server has formed and the acyclic nature
894    of the IRC tree broken.
895
896    Numeric Replies:
897
898            ERR_ALREADYREGISTRED
899
900    Example:
901
902
903
904
905 Oikarinen & Reed                                               [Page 16]
906 \f
907 RFC 1459              Internet Relay Chat Protocol              May 1993
908
909
910 SERVER test.oulu.fi 1 :[tolsun.oulu.fi] Experimental server
911                                 ; New server test.oulu.fi introducing
912                                 itself and attempting to register.  The
913                                 name in []'s is the hostname for the
914                                 host running test.oulu.fi.
915
916
917 :tolsun.oulu.fi SERVER csd.bu.edu 5 :BU Central Server
918                                 ; Server tolsun.oulu.fi is our uplink
919                                 for csd.bu.edu which is 5 hops away.
920
921 4.1.5 Oper
922
923       Command: OPER
924    Parameters: <user> <password>
925
926    OPER message is used by a normal user to obtain operator privileges.
927    The combination of <user> and <password> are required to gain
928    Operator privileges.
929
930    If the client sending the OPER command supplies the correct password
931    for the given user, the server then informs the rest of the network
932    of the new operator by issuing a "MODE +o" for the clients nickname.
933
934    The OPER message is client-server only.
935
936    Numeric Replies:
937
938            ERR_NEEDMOREPARAMS              RPL_YOUREOPER
939            ERR_NOOPERHOST                  ERR_PASSWDMISMATCH
940
941    Example:
942
943    OPER foo bar                    ; Attempt to register as an operator
944                                    using a username of "foo" and "bar" as
945                                    the password.
946
947 4.1.6 Quit
948
949       Command: QUIT
950    Parameters: [<Quit message>]
951
952    A client session is ended with a quit message.  The server must close
953    the connection to a client which sends a QUIT message. If a "Quit
954    Message" is given, this will be sent instead of the default message,
955    the nickname.
956
957    When netsplits (disconnecting of two servers) occur, the quit message
958
959
960
961 Oikarinen & Reed                                               [Page 17]
962 \f
963 RFC 1459              Internet Relay Chat Protocol              May 1993
964
965
966    is composed of the names of two servers involved, separated by a
967    space.  The first name is that of the server which is still connected
968    and the second name is that of the server that has become
969    disconnected.
970
971    If, for some other reason, a client connection is closed without  the
972    client  issuing  a  QUIT  command  (e.g.  client  dies and EOF occurs
973    on socket), the server is required to fill in the quit  message  with
974    some sort  of  message  reflecting the nature of the event which
975    caused it to happen.
976
977    Numeric Replies:
978
979            None.
980
981    Examples:
982
983    QUIT :Gone to have lunch        ; Preferred message format.
984
985 4.1.7 Server quit message
986
987       Command: SQUIT
988    Parameters: <server> <comment>
989
990    The SQUIT message is needed to tell about quitting or dead servers.
991    If a server wishes to break the connection to another server it must
992    send a SQUIT message to the other server, using the the name of the
993    other server as the server parameter, which then closes its
994    connection to the quitting server.
995
996    This command is also available operators to help keep a network of
997    IRC servers connected in an orderly fashion.  Operators may also
998    issue an SQUIT message for a remote server connection.  In this case,
999    the SQUIT must be parsed by each server inbetween the operator and
1000    the remote server, updating the view of the network held by each
1001    server as explained below.
1002
1003    The <comment> should be supplied by all operators who execute a SQUIT
1004    for a remote server (that is not connected to the server they are
1005    currently on) so that other operators are aware for the reason of
1006    this action.  The <comment> is also filled in by servers which may
1007    place an error or similar message here.
1008
1009    Both of the servers which are on either side of the connection being
1010    closed are required to to send out a SQUIT message (to all its other
1011    server connections) for all other servers which are considered to be
1012    behind that link.
1013
1014
1015
1016
1017 Oikarinen & Reed                                               [Page 18]
1018 \f
1019 RFC 1459              Internet Relay Chat Protocol              May 1993
1020
1021
1022    Similarly, a QUIT message must be sent to the other connected servers
1023    rest of the network on behalf of all clients behind that link.  In
1024    addition to this, all channel members of a channel which lost a
1025    member due to the split must be sent a QUIT message.
1026
1027    If a server connection is terminated prematurely (e.g. the server  on
1028    the  other  end  of  the  link  died),  the  server  which  detects
1029    this disconnection is required to inform the rest of  the  network
1030    that  the connection  has  closed  and  fill  in  the comment field
1031    with something appropriate.
1032
1033    Numeric replies:
1034
1035            ERR_NOPRIVILEGES                ERR_NOSUCHSERVER
1036
1037    Example:
1038
1039    SQUIT tolsun.oulu.fi :Bad Link ? ; the server link tolson.oulu.fi has
1040                                    been terminated because of "Bad Link".
1041
1042    :Trillian SQUIT cm22.eng.umd.edu :Server out of control
1043                                     ; message from Trillian to disconnect
1044                                    "cm22.eng.umd.edu" from the net
1045                                     because "Server out of control".
1046
1047 4.2 Channel operations
1048
1049    This group of messages is concerned with manipulating channels, their
1050    properties (channel modes), and their contents (typically clients).
1051    In implementing these, a number of race conditions are inevitable
1052    when clients at opposing ends of a network send commands which will
1053    ultimately clash.  It is also required that servers keep a nickname
1054    history to ensure that wherever a <nick> parameter is given, the
1055    server check its history in case it has recently been changed.
1056
1057 4.2.1 Join message
1058
1059       Command: JOIN
1060    Parameters: <channel>{,<channel>} [<key>{,<key>}]
1061
1062    The JOIN command is used by client to start listening a specific
1063    channel. Whether or not a client is allowed to join a channel is
1064    checked only by the server the client is connected to; all other
1065    servers automatically add the user to the channel when it is received
1066    from other servers.  The conditions which affect this are as follows:
1067
1068            1.  the user must be invited if the channel is invite-only;
1069
1070
1071
1072
1073 Oikarinen & Reed                                               [Page 19]
1074 \f
1075 RFC 1459              Internet Relay Chat Protocol              May 1993
1076
1077
1078            2.  the user's nick/username/hostname must not match any
1079                active bans;
1080
1081            3.  the correct key (password) must be given if it is set.
1082
1083    These are discussed in more detail under the MODE command (see
1084    section 4.2.3 for more details).
1085
1086    Once a user has joined a channel, they receive notice about all
1087    commands their server receives which affect the channel.  This
1088    includes MODE, KICK, PART, QUIT and of course PRIVMSG/NOTICE.  The
1089    JOIN command needs to be broadcast to all servers so that each server
1090    knows where to find the users who are on the channel.  This allows
1091    optimal delivery of PRIVMSG/NOTICE messages to the channel.
1092
1093    If a JOIN is successful, the user is then sent the channel's topic
1094    (using RPL_TOPIC) and the list of users who are on the channel (using
1095    RPL_NAMREPLY), which must include the user joining.
1096
1097    Numeric Replies:
1098
1099            ERR_NEEDMOREPARAMS              ERR_BANNEDFROMCHAN
1100            ERR_INVITEONLYCHAN              ERR_BADCHANNELKEY
1101            ERR_CHANNELISFULL               ERR_BADCHANMASK
1102            ERR_NOSUCHCHANNEL               ERR_TOOMANYCHANNELS
1103            RPL_TOPIC
1104
1105    Examples:
1106
1107    JOIN #foobar                    ; join channel #foobar.
1108
1109    JOIN &foo fubar                 ; join channel &foo using key "fubar".
1110
1111    JOIN #foo,&bar fubar            ; join channel #foo using key "fubar"
1112                                    and &bar using no key.
1113
1114    JOIN #foo,#bar fubar,foobar     ; join channel #foo using key "fubar".
1115                                    and channel #bar using key "foobar".
1116
1117    JOIN #foo,#bar                  ; join channels #foo and #bar.
1118
1119    :WiZ JOIN #Twilight_zone        ; JOIN message from WiZ
1120
1121 4.2.2 Part message
1122
1123       Command: PART
1124    Parameters: <channel>{,<channel>}
1125
1126
1127
1128
1129 Oikarinen & Reed                                               [Page 20]
1130 \f
1131 RFC 1459              Internet Relay Chat Protocol              May 1993
1132
1133
1134    The PART message causes the client sending the message to be removed
1135    from the list of active users for all given channels listed in the
1136    parameter string.
1137
1138    Numeric Replies:
1139
1140            ERR_NEEDMOREPARAMS              ERR_NOSUCHCHANNEL
1141            ERR_NOTONCHANNEL
1142
1143    Examples:
1144
1145    PART #twilight_zone             ; leave channel "#twilight_zone"
1146
1147    PART #oz-ops,&group5            ; leave both channels "&group5" and
1148                                    "#oz-ops".
1149
1150 4.2.3 Mode message
1151
1152       Command: MODE
1153
1154    The MODE command is a dual-purpose command in IRC.  It allows both
1155    usernames and channels to have their mode changed.  The rationale for
1156    this choice is that one day nicknames will be obsolete and the
1157    equivalent property will be the channel.
1158
1159    When parsing MODE messages, it is recommended that the entire message
1160    be parsed first and then the changes which resulted then passed on.
1161
1162 4.2.3.1 Channel modes
1163
1164    Parameters: <channel> {[+|-]|o|p|s|i|t|n|b|v} [<limit>] [<user>]
1165                [<ban mask>]
1166
1167    The MODE command is provided so that channel operators may change the
1168    characteristics of `their' channel.  It is also required that servers
1169    be able to change channel modes so that channel operators may be
1170    created.
1171
1172    The various modes available for channels are as follows:
1173
1174            o - give/take channel operator privileges;
1175            p - private channel flag;
1176            s - secret channel flag;
1177            i - invite-only channel flag;
1178            t - topic settable by channel operator only flag;
1179            n - no messages to channel from clients on the outside;
1180            m - moderated channel;
1181            l - set the user limit to channel;
1182
1183
1184
1185 Oikarinen & Reed                                               [Page 21]
1186 \f
1187 RFC 1459              Internet Relay Chat Protocol              May 1993
1188
1189
1190            b - set a ban mask to keep users out;
1191            v - give/take the ability to speak on a moderated channel;
1192            k - set a channel key (password).
1193
1194    When using the 'o' and 'b' options, a restriction on a total of three
1195    per mode command has been imposed.  That is, any combination of 'o'
1196    and
1197
1198 4.2.3.2 User modes
1199
1200    Parameters: <nickname> {[+|-]|i|w|s|o}
1201
1202    The user MODEs are typically changes which affect either how the
1203    client is seen by others or what 'extra' messages the client is sent.
1204    A user MODE command may only be accepted if both the sender of the
1205    message and the nickname given as a parameter are both the same.
1206
1207    The available modes are as follows:
1208
1209            i - marks a users as invisible;
1210            s - marks a user for receipt of server notices;
1211            w - user receives wallops;
1212            o - operator flag.
1213
1214    Additional modes may be available later on.
1215
1216    If a user attempts to make themselves an operator using the "+o"
1217    flag, the attempt should be ignored.  There is no restriction,
1218    however, on anyone `deopping' themselves (using "-o").  Numeric
1219    Replies:
1220
1221            ERR_NEEDMOREPARAMS              RPL_CHANNELMODEIS
1222            ERR_CHANOPRIVSNEEDED            ERR_NOSUCHNICK
1223            ERR_NOTONCHANNEL                ERR_KEYSET
1224            RPL_BANLIST                     RPL_ENDOFBANLIST
1225            ERR_UNKNOWNMODE                 ERR_NOSUCHCHANNEL
1226
1227            ERR_USERSDONTMATCH              RPL_UMODEIS
1228            ERR_UMODEUNKNOWNFLAG
1229
1230    Examples:
1231
1232            Use of Channel Modes:
1233
1234 MODE #Finnish +im               ; Makes #Finnish channel moderated and
1235                                 'invite-only'.
1236
1237 MODE #Finnish +o Kilroy         ; Gives 'chanop' privileges to Kilroy on
1238
1239
1240
1241 Oikarinen & Reed                                               [Page 22]
1242 \f
1243 RFC 1459              Internet Relay Chat Protocol              May 1993
1244
1245
1246                                 channel #Finnish.
1247
1248 MODE #Finnish +v Wiz            ; Allow WiZ to speak on #Finnish.
1249
1250 MODE #Fins -s                   ; Removes 'secret' flag from channel
1251                                 #Fins.
1252
1253 MODE #42 +k oulu                ; Set the channel key to "oulu".
1254
1255 MODE #eu-opers +l 10            ; Set the limit for the number of users
1256                                 on channel to 10.
1257
1258 MODE &oulu +b                   ; list ban masks set for channel.
1259
1260 MODE &oulu +b *!*@*             ; prevent all users from joining.
1261
1262 MODE &oulu +b *!*@*.edu         ; prevent any user from a hostname
1263                                 matching *.edu from joining.
1264
1265         Use of user Modes:
1266
1267 :MODE WiZ -w                    ; turns reception of WALLOPS messages
1268                                 off for WiZ.
1269
1270 :Angel MODE Angel +i            ; Message from Angel to make themselves
1271                                 invisible.
1272
1273 MODE WiZ -o                     ; WiZ 'deopping' (removing operator
1274                                 status).  The plain reverse of this
1275                                 command ("MODE WiZ +o") must not be
1276                                 allowed from users since would bypass
1277                                 the OPER command.
1278
1279 4.2.4 Topic message
1280
1281       Command: TOPIC
1282    Parameters: <channel> [<topic>]
1283
1284    The TOPIC message is used to change or view the topic of a channel.
1285    The topic for channel <channel> is returned if there is no <topic>
1286    given.  If the <topic> parameter is present, the topic for that
1287    channel will be changed, if the channel modes permit this action.
1288
1289    Numeric Replies:
1290
1291            ERR_NEEDMOREPARAMS              ERR_NOTONCHANNEL
1292            RPL_NOTOPIC                     RPL_TOPIC
1293            ERR_CHANOPRIVSNEEDED
1294
1295
1296
1297 Oikarinen & Reed                                               [Page 23]
1298 \f
1299 RFC 1459              Internet Relay Chat Protocol              May 1993
1300
1301
1302    Examples:
1303
1304    :Wiz TOPIC #test :New topic     ;User Wiz setting the topic.
1305
1306    TOPIC #test :another topic      ;set the topic on #test to "another
1307                                    topic".
1308
1309    TOPIC #test                     ; check the topic for #test.
1310
1311 4.2.5 Names message
1312
1313       Command: NAMES
1314    Parameters: [<channel>{,<channel>}]
1315
1316    By using the NAMES command, a user can list all nicknames that are
1317    visible to them on any channel that they can see.  Channel names
1318    which they can see are those which aren't private (+p) or secret (+s)
1319    or those which they are actually on.  The <channel> parameter
1320    specifies which channel(s) to return information about if valid.
1321    There is no error reply for bad channel names.
1322
1323    If no <channel> parameter is given, a list of all channels and their
1324    occupants is returned.  At the end of this list, a list of users who
1325    are visible but either not on any channel or not on a visible channel
1326    are listed as being on `channel' "*".
1327
1328    Numerics:
1329
1330            RPL_NAMREPLY                    RPL_ENDOFNAMES
1331            ERR_NEEDMOREPARAMS
1332
1333    Examples:
1334
1335    NAMES #twilight_zone,#42        ; list visible users on #twilight_zone
1336                                    and #42 if the channels are visible to
1337                                    you.
1338
1339    NAMES 0                         ; list all visible channels and users
1340
1341    NAMES                           ; does nothing because of the amount
1342                                    of users that would do it by accident
1343
1344 4.2.6 List message
1345
1346       Command: LIST
1347    Parameters: [<channel>{,<channel>} [<server>]]
1348
1349    The list message is used to list channels and their topics.  If  the
1350    <channel>  parameter  is  used,  only  the  status  of  that  channel
1351    is displayed.  Private  channels  are  listed  (without  their
1352    topics)  as channel "Prv" unless the client generating the query is
1353    actually on that channel.  Likewise, secret channels are not listed
1354
1355
1356
1357 Oikarinen & Reed                                               [Page 24]
1358 \f
1359 RFC 1459              Internet Relay Chat Protocol              May 1993
1360
1361
1362    at  all  unless  the client is a member of the channel in question.
1363
1364    Numeric Replies:
1365
1366            ERR_NOSUCHSERVER                RPL_LISTSTART
1367            RPL_LIST                        RPL_LISTEND
1368
1369    Examples:
1370
1371    LIST                            ; List all channels.
1372
1373    LIST #twilight_zone,#42         ; List channels #twilight_zone and #42
1374
1375 4.2.7 Invite message
1376
1377       Command: INVITE
1378    Parameters: <nickname> <channel>
1379
1380    The INVITE message is used to invite users to a channel.  The
1381    parameter <nickname> is the nickname of the person to be invited to
1382    the target channel <channel>.  There is no requirement that the
1383    channel the target user is being invited to must exist or be a valid
1384    channel.  To invite a user to a channel which is invite only (MODE
1385    +i), the client sending the invite must be recognised as being a
1386    channel operator on the given channel.
1387
1388    Numeric Replies:
1389
1390            ERR_NEEDMOREPARAMS              ERR_NOSUCHNICK
1391            ERR_NOTONCHANNEL                ERR_USERONCHANNEL
1392            ERR_CHANOPRIVSNEEDED
1393            RPL_INVITING                    RPL_AWAY
1394
1395    Examples:
1396
1397    :Angel INVITE Wiz #Dust         ; User Angel inviting WiZ to channel
1398                                    #Dust
1399
1400    INVITE Wiz #Twilight_Zone       ; Command to invite WiZ to
1401                                    #Twilight_zone
1402
1403 4.2.8 Kick command
1404
1405       Command: KICK
1406    Parameters: <channel> <user> [<comment>]
1407
1408    The KICK command can be  used  to  forcibly  remove  a  user  from  a
1409    channel.   It  'kicks  them  out'  of the channel (forced PART).
1410
1411
1412
1413 Oikarinen & Reed                                               [Page 25]
1414 \f
1415 RFC 1459              Internet Relay Chat Protocol              May 1993
1416
1417
1418    Only a channel operator may kick another user out of a  channel.
1419    Each  server that  receives  a KICK message checks that it is valid
1420    (ie the sender is actually a  channel  operator)  before  removing
1421    the  victim  from  the channel.
1422
1423    Numeric Replies:
1424
1425            ERR_NEEDMOREPARAMS              ERR_NOSUCHCHANNEL
1426            ERR_BADCHANMASK                 ERR_CHANOPRIVSNEEDED
1427            ERR_NOTONCHANNEL
1428
1429    Examples:
1430
1431 KICK &Melbourne Matthew         ; Kick Matthew from &Melbourne
1432
1433 KICK #Finnish John :Speaking English
1434                                 ; Kick John from #Finnish using
1435                                 "Speaking English" as the reason
1436                                 (comment).
1437
1438 :WiZ KICK #Finnish John         ; KICK message from WiZ to remove John
1439                                 from channel #Finnish
1440
1441 NOTE:
1442      It is possible to extend the KICK command parameters to the
1443 following:
1444
1445 <channel>{,<channel>} <user>{,<user>} [<comment>]
1446
1447 4.3 Server queries and commands
1448
1449    The server query group of commands has been designed to return
1450    information about any server which is connected to the network.  All
1451    servers connected must respond to these queries and respond
1452    correctly.  Any invalid response (or lack thereof) must be considered
1453    a sign of a broken server and it must be disconnected/disabled as
1454    soon as possible until the situation is remedied.
1455
1456    In these queries, where a parameter appears as "<server>", it will
1457    usually mean it can be a nickname or a server or a wildcard name of
1458    some sort.  For each parameter, however, only one query and set of
1459    replies is to be generated.
1460
1461 4.3.1 Version message
1462
1463       Command: VERSION
1464    Parameters: [<server>]
1465
1466
1467
1468
1469 Oikarinen & Reed                                               [Page 26]
1470 \f
1471 RFC 1459              Internet Relay Chat Protocol              May 1993
1472
1473
1474    The VERSION message is used  to  query  the  version  of  the  server
1475    program.  An optional parameter <server> is used to query the version
1476    of the server program which a client is not directly connected to.
1477
1478    Numeric Replies:
1479
1480            ERR_NOSUCHSERVER                RPL_VERSION
1481
1482    Examples:
1483
1484    :Wiz VERSION *.se               ; message from Wiz to check the version
1485                                    of a server matching "*.se"
1486
1487    VERSION tolsun.oulu.fi          ; check the version of server
1488                                    "tolsun.oulu.fi".
1489
1490 4.3.2 Stats message
1491
1492       Command: STATS
1493    Parameters: [<query> [<server>]]
1494
1495    Many stats commands are only available to opers, please document
1496    which ones are available to users and which are available to opers.
1497
1498    The stats message is used to query statistics of certain server.  If
1499    <server> parameter is omitted, only the end of stats reply is sent
1500    back.  The implementation of this command is highly dependent on the
1501    server which replies, although the server must be able to supply
1502    information as described by the queries below (or similar).
1503
1504    A query may be given by any single letter which is only checked by
1505    the destination server (if given as the <server> parameter) and is
1506    otherwise passed on by intermediate servers, ignored and unaltered.
1507    The following queries are those found in the current IRC
1508    implementation and provide a large portion of the setup information
1509    for that server.  Although these may not be supported in the same way
1510    by other versions, all servers should be able to supply a valid reply
1511    to a STATS query which is consistent with the reply formats currently
1512    used and the purpose of the query.
1513
1514    The currently supported queries are:
1515
1516            c - returns a list of servers which the server may connect
1517                to or allow connections from;
1518            h - returns a list of servers which are either forced to be
1519                treated as leaves or allowed to act as hubs;
1520            i - returns a list of hosts which the server allows a client
1521                to connect from;
1522            k - returns a list of banned username/hostname combinations
1523                for that server;
1524            l - returns a list of the server's connections, showing how
1525
1526
1527
1528 Oikarinen & Reed                                               [Page 27]
1529 \f
1530 RFC 1459              Internet Relay Chat Protocol              May 1993
1531
1532
1533                long each connection has been established and the traffic
1534                over that connection in bytes and messages for each
1535                direction;
1536            m - returns a list of commands supported by the server and
1537                the usage count for each if the usage count is non zero;
1538            o - returns a list of hosts from which normal clients may
1539                become operators;
1540            y - show Y (Class) lines from server's configuration file;
1541            u - returns a string showing how long the server has been up.
1542
1543    Numeric Replies:
1544
1545            ERR_NOSUCHSERVER
1546            RPL_STATSCLINE                  RPL_STATSNLINE
1547            RPL_STATSILINE                  RPL_STATSKLINE
1548            RPL_STATSQLINE                  RPL_STATSLLINE
1549            RPL_STATSLINKINFO               RPL_STATSUPTIME
1550            RPL_STATSCOMMANDS               RPL_STATSOLINE
1551            RPL_STATSHLINE                  RPL_ENDOFSTATS
1552
1553    Examples:
1554
1555 STATS m                         ; check the command usage for the server
1556                                 you are connected to
1557
1558 :Wiz STATS c eff.org            ; request by WiZ for C/N line
1559                                 information from server eff.org
1560
1561 4.3.3 Links message
1562
1563       Command: LINKS
1564    Parameters: [[<remote server>] <server mask>]
1565
1566    With LINKS, a user can list all servers which are known by the server
1567    answering the query.  The returned list of servers must match the
1568    mask, or if no mask is given, the full list is returned.
1569
1570    If <remote server> is given in addition to <server mask>, the LINKS
1571    command is forwarded to the first server found that matches that name
1572    (if any), and that server is then required to answer the query.
1573
1574    Numeric Replies:
1575
1576            ERR_NOSUCHSERVER
1577            RPL_LINKS                       RPL_ENDOFLINKS
1578
1579    Examples:
1580
1581
1582
1583
1584 Oikarinen & Reed                                               [Page 28]
1585 \f
1586 RFC 1459              Internet Relay Chat Protocol              May 1993
1587
1588
1589 LINKS *.au                      ; list all servers which have a name
1590                                 that matches *.au;
1591
1592 :WiZ LINKS *.bu.edu *.edu       ; LINKS message from WiZ to the first
1593                                 server matching *.edu for a list of
1594                                 servers matching *.bu.edu.
1595
1596 4.3.4 Time message
1597
1598       Command: TIME
1599    Parameters: [<server>]
1600
1601    The time message is used to query local time from the specified
1602    server. If the server parameter is not given, the server handling the
1603    command must reply to the query.
1604
1605    Numeric Replies:
1606
1607            ERR_NOSUCHSERVER                RPL_TIME
1608
1609    Examples:
1610
1611    TIME tolsun.oulu.fi             ; check the time on the server
1612                                    "tolson.oulu.fi"
1613
1614    Angel TIME *.au                 ; user angel checking the time on a
1615                                    server matching "*.au"
1616
1617 4.3.5 Connect message
1618
1619       Command: CONNECT
1620    Parameters: <target server> [<port> [<remote server>]]
1621
1622    The CONNECT command can be used to force a server to try to establish
1623    a new connection to another server immediately.  CONNECT is a
1624    privileged command and is to be available only to IRC Operators.  If
1625    a remote server is given then the CONNECT attempt is made by that
1626    server to <target server> and <port>.
1627
1628    Numeric Replies:
1629
1630            ERR_NOSUCHSERVER                ERR_NOPRIVILEGES
1631            ERR_NEEDMOREPARAMS
1632
1633    Examples:
1634
1635 CONNECT tolsun.oulu.fi          ; Attempt to connect a server to
1636                                 tolsun.oulu.fi
1637
1638
1639
1640 Oikarinen & Reed                                               [Page 29]
1641 \f
1642 RFC 1459              Internet Relay Chat Protocol              May 1993
1643
1644
1645 :WiZ CONNECT eff.org 6667 csd.bu.edu
1646                                 ; CONNECT attempt by WiZ to get servers
1647                                 eff.org and csd.bu.edu connected on port
1648                                 6667.
1649
1650 4.3.6 Trace message
1651
1652       Command: TRACE
1653    Parameters: [<server>]
1654
1655    TRACE command is used to find the route to specific server.  Each
1656    server that processes this message must tell the sender about it by
1657    sending a reply indicating it is a pass-through link, forming a chain
1658    of replies similar to that gained from using "traceroute".  After
1659    sending this reply back, it must then send the TRACE message to the
1660    next server until given server is reached.  If the <server> parameter
1661    is omitted, it is recommended that TRACE command send a message to
1662    the sender telling which servers the current server has direct
1663    connection to.
1664
1665    If the destination given by "<server>" is an actual server, then the
1666    destination server is required to report all servers and users which
1667    are connected to it, although only operators are permitted to see
1668    users present.  If the destination given by <server> is a nickname,
1669    they only a reply for that nickname is given.
1670
1671    Numeric Replies:
1672
1673            ERR_NOSUCHSERVER
1674
1675    If the TRACE message is destined for another server, all intermediate
1676    servers must return a RPL_TRACELINK reply to indicate that the TRACE
1677    passed through it and where its going next.
1678
1679            RPL_TRACELINK
1680    A TRACE reply may be composed of any number of the following numeric
1681    replies.
1682
1683            RPL_TRACECONNECTING             RPL_TRACEHANDSHAKE
1684            RPL_TRACEUNKNOWN                RPL_TRACEOPERATOR
1685            RPL_TRACEUSER                   RPL_TRACESERVER
1686            RPL_TRACESERVICE                RPL_TRACENEWTYPE
1687            RPL_TRACECLASS
1688
1689    Examples:
1690
1691 TRACE *.oulu.fi                 ; TRACE to a server matching *.oulu.fi
1692
1693
1694
1695
1696 Oikarinen & Reed                                               [Page 30]
1697 \f
1698 RFC 1459              Internet Relay Chat Protocol              May 1993
1699
1700
1701 :WiZ TRACE AngelDust            ; TRACE issued by WiZ to nick AngelDust
1702
1703 4.3.7 Admin command
1704
1705       Command: ADMIN
1706    Parameters: [<server>]
1707
1708    The admin message is used to find the name of the administrator of
1709    the given server, or current server if <server> parameter is omitted.
1710    Each server must have the ability to forward ADMIN messages to other
1711    servers.
1712
1713    Numeric Replies:
1714
1715            ERR_NOSUCHSERVER
1716            RPL_ADMINME                     RPL_ADMINLOC1
1717            RPL_ADMINLOC2                   RPL_ADMINEMAIL
1718
1719    Examples:
1720
1721    ADMIN tolsun.oulu.fi            ; request an ADMIN reply from
1722                                    tolsun.oulu.fi
1723
1724    :WiZ ADMIN *.edu                ; ADMIN request from WiZ for first
1725                                    server found to match *.edu.
1726
1727 4.3.8 Info command
1728
1729       Command: INFO
1730    Parameters: [<server>]
1731
1732    The INFO command is required to return information which describes
1733    the server: its version, when it was compiled, the patchlevel, when
1734    it was started, and any other miscellaneous information which may be
1735    considered to be relevant.
1736
1737    Numeric Replies:
1738
1739            ERR_NOSUCHSERVER
1740            RPL_INFO                        RPL_ENDOFINFO
1741
1742    Examples:
1743
1744    INFO csd.bu.edu                 ; request an INFO reply from
1745    csd.bu.edu
1746
1747    :Avalon INFO *.fi               ; INFO request from Avalon for first
1748                                    server found to match *.fi.
1749
1750
1751
1752 Oikarinen & Reed                                               [Page 31]
1753 \f
1754 RFC 1459              Internet Relay Chat Protocol              May 1993
1755
1756
1757    INFO Angel                      ; request info from the server that
1758                                    Angel is connected to.
1759
1760 4.4 Sending messages
1761
1762    The main purpose of the IRC protocol is to provide a base for clients
1763    to communicate with each other.  PRIVMSG and NOTICE are the only
1764    messages available which actually perform delivery of a text message
1765    from one client to another - the rest just make it possible and try
1766    to ensure it happens in a reliable and structured manner.
1767
1768 4.4.1 Private messages
1769
1770       Command: PRIVMSG
1771    Parameters: <receiver>{,<receiver>} <text to be sent>
1772
1773    PRIVMSG is used to send private messages between users.  <receiver>
1774    is the nickname of the receiver of the message.  <receiver> can also
1775    be a list of names or channels separated with commas.
1776
1777    The <receiver> parameter may also me a host mask  ($@mask)  or  server
1778    mask  ($mask).   In  both cases the server will only send the PRIVMSG
1779    to those who have a server or host matching the mask.  The mask  must
1780    have at  least  1  (one)  "."  in it and no wildcards following the
1781    last ".".  This requirement exists to prevent people sending messages
1782    to  "$@*"  or "$*",  which  would  broadcast  to  all  users; from
1783    experience, this is abused more than used responsibly and properly.
1784    Wildcards are  the  '*' and  '?'   characters.   This  extension  to
1785    the PRIVMSG command is only available to Operators.
1786
1787    Numeric Replies:
1788
1789            ERR_NORECIPIENT                 ERR_NOTEXTTOSEND
1790            ERR_CANNOTSENDTOCHAN            ERR_NOTOPLEVEL
1791            ERR_WILDTOPLEVEL                ERR_TOOMANYTARGETS
1792            ERR_NOSUCHNICK
1793            RPL_AWAY
1794
1795    Examples:
1796
1797 :Angel PRIVMSG Wiz :Hello are you receiving this message ?
1798                                 ; Message from Angel to Wiz.
1799
1800 PRIVMSG Angel :yes I'm receiving it !receiving it !'u>(768u+1n) .br ;
1801                                 Message to Angel.
1802
1803 PRIVMSG jto@tolsun.oulu.fi :Hello !
1804                                 ; Message to a client on server
1805
1806
1807
1808 Oikarinen & Reed                                               [Page 32]
1809 \f
1810 RFC 1459              Internet Relay Chat Protocol              May 1993
1811
1812
1813                                 tolsun.oulu.fi with username of "jto".
1814
1815 PRIVMSG $*.fi :Server tolsun.oulu.fi rebooting.
1816                                 ; Message to everyone on a server which
1817                                 has a name matching *.fi.
1818
1819 PRIVMSG $@*.edu :NSFNet is undergoing work, expect interruptions
1820                                 ; Message to all users who come from a
1821                                 host which has a name matching *.edu.
1822
1823 4.4.2 Notice
1824
1825       Command: NOTICE
1826    Parameters: <nickname> <text>
1827
1828    The NOTICE message is used similarly to PRIVMSG.  The difference
1829    between NOTICE and PRIVMSG is that automatic replies must never be
1830    sent in response to a NOTICE message.  This rule applies to servers
1831    too - they must not send any error reply back to the client on
1832    receipt of a notice.  The object of this rule is to avoid loops
1833    between a client automatically sending something in response to
1834    something it received.  This is typically used by automatons (clients
1835    with either an AI or other interactive program controlling their
1836    actions) which are always seen to be replying lest they end up in a
1837    loop with another automaton.
1838
1839    See PRIVMSG for more details on replies and examples.
1840
1841 4.5 User based queries
1842
1843    User queries are a group of commands which are primarily concerned
1844    with finding details on a particular user or group users.  When using
1845    wildcards with any of these commands, if they match, they will only
1846    return information on users who are 'visible' to you.  The visibility
1847    of a user is determined as a combination of the user's mode and the
1848    common set of channels you are both on.
1849
1850 4.5.1 Who query
1851
1852       Command: WHO
1853    Parameters: [<name> [<o>]]
1854
1855    The WHO message is used by a client to generate a query which returns
1856    a list of information which 'matches' the <name> parameter given by
1857    the client.  In the absence of the <name> parameter, all visible
1858    (users who aren't invisible (user mode +i) and who don't have a
1859    common channel with the requesting client) are listed.  The same
1860    result can be achieved by using a <name> of "0" or any wildcard which
1861
1862
1863
1864 Oikarinen & Reed                                               [Page 33]
1865 \f
1866 RFC 1459              Internet Relay Chat Protocol              May 1993
1867
1868
1869    will end up matching every entry possible.
1870
1871    The <name> passed to WHO is matched against users' host, server, real
1872    name and nickname if the channel <name> cannot be found.
1873
1874    If the "o" parameter is passed only operators are returned according
1875    to the name mask supplied.
1876
1877    Numeric Replies:
1878
1879            ERR_NOSUCHSERVER
1880            RPL_WHOREPLY                    RPL_ENDOFWHO
1881
1882    Examples:
1883
1884    WHO *.fi                        ; List all users who match against
1885                                    "*.fi".
1886
1887    WHO jto* o                      ; List all users with a match against
1888                                    "jto*" if they are an operator.
1889
1890 4.5.2 Whois query
1891
1892       Command: WHOIS
1893    Parameters: [<server>] <nickmask>[,<nickmask>[,...]]
1894
1895    This message is used to query information about particular user.  The
1896    server will answer this message with several numeric messages
1897    indicating different statuses of each user which matches the nickmask
1898    (if you are entitled to see them).  If no wildcard is present in the
1899    <nickmask>, any information about that nick which you are allowed to
1900    see is presented.  A comma (',') separated list of nicknames may be
1901    given.
1902
1903    The latter version sends the query to a specific server.  It is
1904    useful if you want to know how long the user in question has been
1905    idle as only local server (ie. the server the user is directly
1906    connected to) knows that information, while everything else is
1907    globally known.
1908
1909    Numeric Replies:
1910
1911            ERR_NOSUCHSERVER                ERR_NONICKNAMEGIVEN
1912            RPL_WHOISUSER                   RPL_WHOISCHANNELS
1913            RPL_WHOISCHANNELS               RPL_WHOISSERVER
1914            RPL_AWAY                        RPL_WHOISOPERATOR
1915            RPL_WHOISIDLE                   ERR_NOSUCHNICK
1916            RPL_ENDOFWHOIS
1917
1918
1919
1920 Oikarinen & Reed                                               [Page 34]
1921 \f
1922 RFC 1459              Internet Relay Chat Protocol              May 1993
1923
1924
1925    Examples:
1926
1927    WHOIS wiz                       ; return available user information
1928                                    about nick WiZ
1929
1930    WHOIS eff.org trillian          ; ask server eff.org for user
1931                                    information about trillian
1932
1933 4.5.3 Whowas
1934
1935       Command: WHOWAS
1936    Parameters: <nickname> [<count> [<server>]]
1937
1938    Whowas asks for information about a nickname which no longer exists.
1939    This may either be due to a nickname change or the user leaving IRC.
1940    In response to this query, the server searches through its nickname
1941    history, looking for any nicks which are lexically the same (no wild
1942    card matching here).  The history is searched backward, returning the
1943    most recent entry first.  If there are multiple entries, up to
1944    <count> replies will be returned (or all of them if no <count>
1945    parameter is given).  If a non-positive number is passed as being
1946    <count>, then a full search is done.
1947
1948    Numeric Replies:
1949
1950            ERR_NONICKNAMEGIVEN             ERR_WASNOSUCHNICK
1951            RPL_WHOWASUSER                  RPL_WHOISSERVER
1952            RPL_ENDOFWHOWAS
1953
1954    Examples:
1955
1956    WHOWAS Wiz                      ; return all information in the nick
1957                                    history about nick "WiZ";
1958
1959    WHOWAS Mermaid 9                ; return at most, the 9 most recent
1960                                    entries in the nick history for
1961                                    "Mermaid";
1962
1963    WHOWAS Trillian 1 *.edu         ; return the most recent history for
1964                                    "Trillian" from the first server found
1965                                    to match "*.edu".
1966
1967 4.6 Miscellaneous messages
1968
1969    Messages in this category do not fit into any of the above categories
1970    but are nonetheless still a part of and required by the protocol.
1971
1972
1973
1974
1975
1976 Oikarinen & Reed                                               [Page 35]
1977 \f
1978 RFC 1459              Internet Relay Chat Protocol              May 1993
1979
1980
1981 4.6.1 Kill message
1982
1983       Command: KILL
1984    Parameters: <nickname> <comment>
1985
1986    The KILL message is used to cause a client-server connection to be
1987    closed by the server which has the actual connection.  KILL is used
1988    by servers when they encounter a duplicate entry in the list of valid
1989    nicknames and is used to remove both entries.  It is also available
1990    to operators.
1991
1992    Clients which have automatic reconnect algorithms effectively make
1993    this command useless since the disconnection is only brief.  It does
1994    however break the flow of data and can be used to stop large amounts
1995    of being abused, any user may elect to receive KILL messages
1996    generated for others to keep an 'eye' on would be trouble spots.
1997
1998    In an arena where nicknames are required to be globally unique at all
1999    times, KILL messages are sent whenever 'duplicates' are detected
2000    (that is an attempt to register two users with the same nickname) in
2001    the hope that both of them will disappear and only 1 reappear.
2002
2003    The comment given must reflect the actual reason for the KILL.  For
2004    server-generated KILLs it usually is made up of details concerning
2005    the origins of the two conflicting nicknames.  For users it is left
2006    up to them to provide an adequate reason to satisfy others who see
2007    it.  To prevent/discourage fake KILLs from being generated to hide
2008    the identify of the KILLer, the comment also shows a 'kill-path'
2009    which is updated by each server it passes through, each prepending
2010    its name to the path.
2011
2012    Numeric Replies:
2013
2014            ERR_NOPRIVILEGES                ERR_NEEDMOREPARAMS
2015            ERR_NOSUCHNICK                  ERR_CANTKILLSERVER
2016
2017
2018    KILL David (csd.bu.edu <- tolsun.oulu.fi)
2019                                    ; Nickname collision between csd.bu.edu
2020                                    and tolson.oulu.fi
2021
2022
2023    NOTE:
2024    It is recommended that only Operators be allowed to kill other users
2025    with KILL message.  In an ideal world not even operators would need
2026    to do this and it would be left to servers to deal with.
2027
2028
2029
2030
2031
2032 Oikarinen & Reed                                               [Page 36]
2033 \f
2034 RFC 1459              Internet Relay Chat Protocol              May 1993
2035
2036
2037 4.6.2 Ping message
2038
2039       Command: PING
2040    Parameters: <server1> [<server2>]
2041
2042    The PING message is used to test the presence of an active client at
2043    the other end of the connection.  A PING message is sent at regular
2044    intervals if no other activity detected coming from a connection.  If
2045    a connection fails to respond to a PING command within a set amount
2046    of time, that connection is closed.
2047
2048    Any client which receives a PING message must respond to <server1>
2049    (server which sent the PING message out) as quickly as possible with
2050    an appropriate PONG message to indicate it is still there and alive.
2051    Servers should not respond to PING commands but rely on PINGs from
2052    the other end of the connection to indicate the connection is alive.
2053    If the <server2> parameter is specified, the PING message gets
2054    forwarded there.
2055
2056    Numeric Replies:
2057
2058            ERR_NOORIGIN                    ERR_NOSUCHSERVER
2059
2060    Examples:
2061
2062    PING tolsun.oulu.fi             ; server sending a PING message to
2063                                    another server to indicate it is still
2064                                    alive.
2065
2066    PING WiZ                        ; PING message being sent to nick WiZ
2067
2068 4.6.3 Pong message
2069
2070       Command: PONG
2071    Parameters: <daemon> [<daemon2>]
2072
2073    PONG message is a reply to ping message.  If parameter <daemon2> is
2074    given this message must be forwarded to given daemon.  The <daemon>
2075    parameter is the name of the daemon who has responded to PING message
2076    and generated this message.
2077
2078    Numeric Replies:
2079
2080            ERR_NOORIGIN                    ERR_NOSUCHSERVER
2081
2082    Examples:
2083
2084    PONG csd.bu.edu tolsun.oulu.fi  ; PONG message from csd.bu.edu to
2085
2086
2087
2088 Oikarinen & Reed                                               [Page 37]
2089 \f
2090 RFC 1459              Internet Relay Chat Protocol              May 1993
2091
2092
2093                                    tolsun.oulu.fi
2094
2095 4.6.4 Error
2096
2097       Command: ERROR
2098    Parameters: <error message>
2099
2100    The ERROR command is for use by servers when reporting a serious or
2101    fatal error to its operators.  It may also be sent from one server to
2102    another but must not be accepted from any normal unknown clients.
2103
2104    An ERROR message is for use for reporting errors which occur with a
2105    server-to-server link only.  An ERROR message is sent to the server
2106    at the other end (which sends it to all of its connected operators)
2107    and to all operators currently connected.  It is not to be passed
2108    onto any other servers by a server if it is received from a server.
2109
2110    When a server sends a received ERROR message to its operators, the
2111    message should be encapsulated inside a NOTICE message, indicating
2112    that the client was not responsible for the error.
2113
2114    Numerics:
2115
2116            None.
2117
2118    Examples:
2119
2120    ERROR :Server *.fi already exists; ERROR message to the other server
2121                                    which caused this error.
2122
2123    NOTICE WiZ :ERROR from csd.bu.edu -- Server *.fi already exists
2124                                    ; Same ERROR message as above but sent
2125                                    to user WiZ on the other server.
2126
2127 5. OPTIONALS
2128
2129    This section describes OPTIONAL messages.  They are not required in a
2130    working server implementation of the protocol described herein.  In
2131    the absence of the option, an error reply message must be generated
2132    or an unknown command error.  If the message is destined for another
2133    server to answer then it must be passed on (elementary parsing
2134    required) The allocated numerics for this are listed with the
2135    messages below.
2136
2137 5.1 Away
2138
2139       Command: AWAY
2140    Parameters: [message]
2141
2142
2143
2144 Oikarinen & Reed                                               [Page 38]
2145 \f
2146 RFC 1459              Internet Relay Chat Protocol              May 1993
2147
2148
2149    With the AWAY message, clients can set an automatic reply string for
2150    any PRIVMSG commands directed at them (not to a channel they are on).
2151    The automatic reply is sent by the server to client sending the
2152    PRIVMSG command.  The only replying server is the one to which the
2153    sending client is connected to.
2154
2155    The AWAY message is used either with one parameter (to set an AWAY
2156    message) or with no parameters (to remove the AWAY message).
2157
2158    Numeric Replies:
2159
2160            RPL_UNAWAY                      RPL_NOWAWAY
2161
2162    Examples:
2163
2164    AWAY :Gone to lunch.  Back in 5 ; set away message to "Gone to lunch.
2165                                    Back in 5".
2166
2167    :WiZ AWAY                       ; unmark WiZ as being away.
2168
2169
2170 5.2 Rehash message
2171
2172       Command: REHASH
2173    Parameters: None
2174
2175    The rehash message can be used by the operator to force the server to
2176    re-read and process its configuration file.
2177
2178    Numeric Replies:
2179
2180         RPL_REHASHING                   ERR_NOPRIVILEGES
2181
2182 Examples:
2183
2184 REHASH                          ; message from client with operator
2185                                 status to server asking it to reread its
2186                                 configuration file.
2187
2188 5.3 Restart message
2189
2190       Command: RESTART
2191    Parameters: None
2192
2193    The restart message can only be used by an operator to force a server
2194    restart itself.  This message is optional since it may be viewed as a
2195    risk to allow arbitrary people to connect to a server as an operator
2196    and execute this command, causing (at least) a disruption to service.
2197
2198
2199
2200 Oikarinen & Reed                                               [Page 39]
2201 \f
2202 RFC 1459              Internet Relay Chat Protocol              May 1993
2203
2204
2205    The RESTART command must always be fully processed by the server to
2206    which the sending client is connected and not be passed onto other
2207    connected servers.
2208
2209    Numeric Replies:
2210
2211            ERR_NOPRIVILEGES
2212
2213    Examples:
2214
2215    RESTART                         ; no parameters required.
2216
2217                                    running.
2218
2219 5.5 Users
2220
2221       Command: USERS
2222    Parameters: [<server>]
2223
2224
2225
2226 Oikarinen & Reed                                               [Page 40]
2227 \f
2228 RFC 1459              Internet Relay Chat Protocol              May 1993
2229
2230
2231    The USERS command returns a list of users logged into the server in a
2232    similar  format  to  who(1),  rusers(1)  and finger(1).  Some people
2233    may disable this command on their server for security related
2234    reasons.   If disabled, the correct numeric must be returned to
2235    indicate this.
2236
2237    Numeric Replies:
2238
2239            ERR_NOSUCHSERVER                ERR_FILEERROR
2240            RPL_USERSSTART                  RPL_USERS
2241            RPL_NOUSERS                     RPL_ENDOFUSERS
2242            ERR_USERSDISABLED
2243
2244    Disabled Reply:
2245
2246            ERR_USERSDISABLED
2247
2248    Examples:
2249
2250 USERS eff.org                   ; request a list of users logged in on
2251                                 server eff.org
2252
2253 :John USERS tolsun.oulu.fi      ; request from John for a list of users
2254                                 logged in on server tolsun.oulu.fi
2255
2256 5.6 Operwall message
2257
2258       Command: WALLOPS
2259    Parameters: Text to be sent to all operators currently online
2260
2261    Sends  a  message  to  all   operators   currently   online.    After
2262    implementing  WALLOPS  as  a user command it was found that it was
2263    often and commonly abused as a means of sending a message to a lot
2264    of  people (much  similar to WALL).  Due to this it is recommended
2265    that the current implementation of  WALLOPS  be  used  as  an
2266    example  by  allowing  and recognising only servers as the senders of
2267    WALLOPS.
2268
2269    Numeric Replies:
2270
2271            ERR_NEEDMOREPARAMS
2272
2273    Examples:
2274
2275    :csd.bu.edu WALLOPS :Connect '*.uiuc.edu 6667' from Joshua; WALLOPS
2276                                    message from csd.bu.edu announcing a
2277                                    CONNECT message it received and acted
2278                                    upon from Joshua.
2279
2280
2281
2282 Oikarinen & Reed                                               [Page 41]
2283 \f
2284 RFC 1459              Internet Relay Chat Protocol              May 1993
2285
2286
2287 5.7 Userhost message
2288
2289       Command: USERHOST
2290    Parameters: <nickname>{<space><nickname>}
2291
2292    The USERHOST command takes a list of up to 5 nicknames, each
2293    separated by a space character and returns a list of information
2294    about each nickname that it found.  The returned list has each reply
2295    separated by a space.
2296
2297    Numeric Replies:
2298
2299            RPL_USERHOST                    ERR_NEEDMOREPARAMS
2300
2301    Examples:
2302
2303    USERHOST Wiz Michael Marty p    ;USERHOST request for information on
2304                                    nicks "Wiz", "Michael", "Marty" and "p"
2305
2306 5.7.1 Userip message
2307
2308       Command: USERIP
2309    Parameters: <nickname>{<space><nickname>}
2310
2311    The USERHOST command takes a list of up to 5 nicknames, each
2312    separated by a space character and returns a list of information
2313    about each nickname that it found.  The returned list has each reply
2314    separated by a space.
2315
2316    Numeric Replies:
2317
2318            RPL_USERIP                    ERR_NEEDMOREPARAMS
2319
2320    Examples:
2321
2322    USERIP Wiz Michael Marty p    ;USERIP request for information on
2323                                    nicks "Wiz", "Michael", "Marty" and "p"
2324
2325 5.8 Ison message
2326
2327       Command: ISON
2328    Parameters: <nickname>{<space><nickname>}
2329
2330    The ISON command was implemented to provide  a  quick  and  efficient
2331    means  to get a response about whether a given nickname was currently
2332    on IRC. ISON only takes one (1) parameter: a space-separated list of
2333    nicks.  For  each  nickname in the list that is present, the server
2334    adds that to its reply string.  Thus the reply string may return
2335    empty (none  of  the given  nicks are present), an exact copy of the
2336    parameter string (all of them present) or as any other subset of the
2337    set of nicks  given  in  the parameter.  The only limit on the number
2338    of nicks that may be checked is that the combined length must not be
2339    too large as to cause the server to chop it off so it fits in 512
2340    characters.
2341
2342    ISON is only be processed by the server local to the client sending
2343    the command and thus not passed onto other servers for further
2344    processing.
2345
2346    Numeric Replies:
2347
2348            RPL_ISON                ERR_NEEDMOREPARAMS
2349
2350    Examples:
2351
2352    ISON phone trillian WiZ jarlek Avalon Angel Monstah
2353                                    ; Sample ISON request for 7 nicks.
2354
2355
2356
2357 Oikarinen & Reed                                               [Page 42]
2358 \f
2359 RFC 1459              Internet Relay Chat Protocol              May 1993
2360
2361
2362 6. REPLIES
2363
2364    The following is a list of numeric replies which are generated in
2365    response to the commands given above.  Each numeric is given with its
2366    number, name and reply string.
2367
2368 6.1 Error Replies.
2369
2370         401     ERR_NOSUCHNICK
2371                         "<nickname> :No such nick/channel"
2372
2373                 - Used to indicate the nickname parameter supplied to a
2374                   command is currently unused.
2375
2376         402     ERR_NOSUCHSERVER
2377                         "<server name> :No such server"
2378
2379                 - Used to indicate the server name given currently
2380                   doesn't exist.
2381
2382         403     ERR_NOSUCHCHANNEL
2383                         "<channel name> :No such channel"
2384
2385                 - Used to indicate the given channel name is invalid.
2386
2387         404     ERR_CANNOTSENDTOCHAN
2388                         "<channel name> :Cannot send to channel"
2389
2390                 - Sent to a user who is either (a) not on a channel
2391                   which is mode +n or (b) not a chanop (or mode +v) on
2392                   a channel which has mode +m set and is trying to send
2393                   a PRIVMSG message to that channel.
2394
2395         405     ERR_TOOMANYCHANNELS
2396                         "<channel name> :You have joined too many \
2397                          channels"
2398                 - Sent to a user when they have joined the maximum
2399                   number of allowed channels and they try to join
2400                   another channel.
2401
2402         406     ERR_WASNOSUCHNICK
2403                         "<nickname> :There was no such nickname"
2404
2405                 - Returned by WHOWAS to indicate there is no history
2406                   information for that nickname.
2407
2408         407     ERR_TOOMANYTARGETS
2409                         "<target> :Duplicate recipients. No message \
2410
2411
2412
2413 Oikarinen & Reed                                               [Page 43]
2414 \f
2415 RFC 1459              Internet Relay Chat Protocol              May 1993
2416
2417
2418                          delivered"
2419
2420                 - Returned to a client which is attempting to send a
2421                   PRIVMSG/NOTICE using the user@host destination format
2422                   and for a user@host which has several occurrences.
2423
2424         409     ERR_NOORIGIN
2425                         ":No origin specified"
2426
2427                 - PING or PONG message missing the originator parameter
2428                   which is required since these commands must work
2429                   without valid prefixes.
2430
2431         411     ERR_NORECIPIENT
2432                         ":No recipient given (<command>)"
2433         412     ERR_NOTEXTTOSEND
2434                         ":No text to send"
2435         413     ERR_NOTOPLEVEL
2436                         "<mask> :No toplevel domain specified"
2437         414     ERR_WILDTOPLEVEL
2438                         "<mask> :Wildcard in toplevel domain"
2439
2440                 - 412 - 414 are returned by PRIVMSG to indicate that
2441                   the message wasn't delivered for some reason.
2442                   ERR_NOTOPLEVEL and ERR_WILDTOPLEVEL are errors that
2443                   are returned when an invalid use of
2444                   "PRIVMSG $<server>" or "PRIVMSG #<host>" is attempted.
2445
2446         421     ERR_UNKNOWNCOMMAND
2447                         "<command> :Unknown command"
2448
2449                 - Returned to a registered client to indicate that the
2450                   command sent is unknown by the server.
2451
2452         422     ERR_NOMOTD
2453                         ":MOTD File is missing"
2454
2455                 - Server's MOTD file could not be opened by the server.
2456
2457         423     ERR_NOADMININFO
2458                         "<server> :No administrative info available"
2459
2460                 - Returned by a server in response to an ADMIN message
2461                   when there is an error in finding the appropriate
2462                   information.
2463
2464         424     ERR_FILEERROR
2465                 ":File error doing <file op> on <file>"
2466
2467
2468
2469 Oikarinen & Reed                                               [Page 44]
2470 \f
2471 RFC 1459              Internet Relay Chat Protocol              May 1993
2472
2473
2474                 - Generic error message used to report a failed file
2475                   operation during the processing of a message.
2476
2477         431     ERR_NONICKNAMEGIVEN
2478                         ":No nickname given"
2479
2480                 - Returned when a nickname parameter expected for a
2481                   command and isn't found.
2482
2483         432     ERR_ERRONEUSNICKNAME
2484                         "<nick> :Erroneus nickname"
2485
2486                 - Returned after receiving a NICK message which contains
2487                   characters which do not fall in the defined set.  See
2488                   section x.x.x for details on valid nicknames.
2489
2490         433     ERR_NICKNAMEINUSE
2491                         "<nick> :Nickname is already in use"
2492
2493                 - Returned when a NICK message is processed that results
2494                   in an attempt to change to a currently existing
2495                   nickname.
2496
2497         436     ERR_NICKCOLLISION
2498                         "<nick> :Nickname collision KILL"
2499
2500                 - Returned by a server to a client when it detects a
2501                   nickname collision (registered of a NICK that
2502                   already exists by another server).
2503
2504         441     ERR_USERNOTINCHANNEL
2505                         "<nick> <channel> :They aren't on that channel"
2506
2507                 - Returned by the server to indicate that the target
2508                   user of the command is not on the given channel.
2509
2510         442     ERR_NOTONCHANNEL
2511                         "<channel> :You're not on that channel"
2512
2513                 - Returned by the server whenever a client tries to
2514                   perform a channel effecting command for which the
2515                   client isn't a member.
2516
2517         443     ERR_USERONCHANNEL
2518                         "<user> <channel> :is already on channel"
2519
2520                 - Returned when a client tries to invite a user to a
2521                   channel they are already on.
2522
2523
2524
2525 Oikarinen & Reed                                               [Page 45]
2526 \f
2527 RFC 1459              Internet Relay Chat Protocol              May 1993
2528
2529
2530         444     ERR_NOLOGIN
2531                         "<user> :User not logged in"
2532
2533                 - Returned by the summon after a SUMMON command for a
2534                   user was unable to be performed since they were not
2535                   logged in.
2536
2537         445     ERR_SUMMONDISABLED
2538                         ":SUMMON has been disabled"
2539
2540                 - Returned as a response to the SUMMON command.  Must be
2541                   returned by any server which does not implement it.
2542
2543         446     ERR_USERSDISABLED
2544                         ":USERS has been disabled"
2545
2546                 - Returned as a response to the USERS command.  Must be
2547                   returned by any server which does not implement it.
2548
2549         451     ERR_NOTREGISTERED
2550                         ":You have not registered"
2551
2552                 - Returned by the server to indicate that the client
2553                   must be registered before the server will allow it
2554                   to be parsed in detail.
2555
2556         461     ERR_NEEDMOREPARAMS
2557                         "<command> :Not enough parameters"
2558
2559                 - Returned by the server by numerous commands to
2560                   indicate to the client that it didn't supply enough
2561                   parameters.
2562
2563         462     ERR_ALREADYREGISTRED
2564                         ":You may not reregister"
2565
2566                 - Returned by the server to any link which tries to
2567                   change part of the registered details (such as
2568                   password or user details from second USER message).
2569
2570
2571         463     ERR_NOPERMFORHOST
2572                         ":Your host isn't among the privileged"
2573
2574                 - Returned to a client which attempts to register with
2575                   a server which does not been setup to allow
2576                   connections from the host the attempted connection
2577                   is tried.
2578
2579
2580
2581 Oikarinen & Reed                                               [Page 46]
2582 \f
2583 RFC 1459              Internet Relay Chat Protocol              May 1993
2584
2585
2586         464     ERR_PASSWDMISMATCH
2587                         ":Password incorrect"
2588
2589                 - Returned to indicate a failed attempt at registering
2590                   a connection for which a password was required and
2591                   was either not given or incorrect.
2592
2593         465     ERR_YOUREBANNEDCREEP
2594                         ":You are banned from this server"
2595
2596                 - Returned after an attempt to connect and register
2597                   yourself with a server which has been setup to
2598                   explicitly deny connections to you.
2599
2600         467     ERR_KEYSET
2601                         "<channel> :Channel key already set"
2602         471     ERR_CHANNELISFULL
2603                         "<channel> :Cannot join channel (+l)"
2604         472     ERR_UNKNOWNMODE
2605                         "<char> :is unknown mode char to me"
2606         473     ERR_INVITEONLYCHAN
2607                         "<channel> :Cannot join channel (+i)"
2608         474     ERR_BANNEDFROMCHAN
2609                         "<channel> :Cannot join channel (+b)"
2610         475     ERR_BADCHANNELKEY
2611                         "<channel> :Cannot join channel (+k)"
2612         481     ERR_NOPRIVILEGES
2613                         ":Permission Denied- You're not an IRC operator"
2614
2615                 - Any command requiring operator privileges to operate
2616                   must return this error to indicate the attempt was
2617                   unsuccessful.
2618
2619         482     ERR_CHANOPRIVSNEEDED
2620                         "<channel> :You're not channel operator"
2621
2622                 - Any command requiring 'chanop' privileges (such as
2623                   MODE messages) must return this error if the client
2624                   making the attempt is not a chanop on the specified
2625                   channel.
2626
2627         483     ERR_CANTKILLSERVER
2628                         ":You cant kill a server!"
2629
2630                 - Any attempts to use the KILL command on a server
2631                   are to be refused and this error returned directly
2632                   to the client.
2633
2634
2635
2636
2637 Oikarinen & Reed                                               [Page 47]
2638 \f
2639 RFC 1459              Internet Relay Chat Protocol              May 1993
2640
2641
2642         491     ERR_NOOPERHOST
2643                         ":No O-lines for your host"
2644
2645                 - If a client sends an OPER message and the server has
2646                   not been configured to allow connections from the
2647                   client's host as an operator, this error must be
2648                   returned.
2649
2650         501     ERR_UMODEUNKNOWNFLAG
2651                         ":Unknown MODE flag"
2652
2653                 - Returned by the server to indicate that a MODE
2654                   message was sent with a nickname parameter and that
2655                   the a mode flag sent was not recognized.
2656
2657         502     ERR_USERSDONTMATCH
2658                         ":Cant change mode for other users"
2659
2660                 - Error sent to any user trying to view or change the
2661                   user mode for a user other than themselves.
2662
2663 6.2 Command responses.
2664
2665         300     RPL_NONE
2666                         Dummy reply number. Not used.
2667
2668         302     RPL_USERHOST
2669                         ":[<reply>{<space><reply>}]"
2670
2671                 - Reply format used by USERHOST to list replies to
2672                   the query list.  The reply string is composed as
2673                   follows:
2674
2675                   <reply> ::= <nick>['*'] '=' <'+'|'-'><hostname>
2676
2677                   The '*' indicates whether the client has registered
2678                   as an Operator.  The '-' or '+' characters represent
2679                   whether the client has set an AWAY message or not
2680                   respectively.
2681
2682         303     RPL_ISON
2683                         ":[<nick> {<space><nick>}]"
2684
2685                 - Reply format used by ISON to list replies to the
2686                   query list.
2687
2688         301     RPL_AWAY
2689                         "<nick> :<away message>"
2690
2691
2692
2693 Oikarinen & Reed                                               [Page 48]
2694 \f
2695 RFC 1459              Internet Relay Chat Protocol              May 1993
2696
2697
2698         305     RPL_UNAWAY
2699                         ":You are no longer marked as being away"
2700         306     RPL_NOWAWAY
2701                         ":You have been marked as being away"
2702
2703                 - These replies are used with the AWAY command (if
2704                   allowed).  RPL_AWAY is sent to any client sending a
2705                   PRIVMSG to a client which is away.  RPL_AWAY is only
2706                   sent by the server to which the client is connected.
2707                   Replies RPL_UNAWAY and RPL_NOWAWAY are sent when the
2708                   client removes and sets an AWAY message.
2709
2710         311     RPL_WHOISUSER
2711                         "<nick> <user> <host> * :<real name>"
2712         312     RPL_WHOISSERVER
2713                         "<nick> <server> :<server info>"
2714         313     RPL_WHOISOPERATOR
2715                         "<nick> :is an IRC operator"
2716         317     RPL_WHOISIDLE
2717                         "<nick> <integer> :seconds idle"
2718         318     RPL_ENDOFWHOIS
2719                         "<nick> :End of /WHOIS list"
2720         319     RPL_WHOISCHANNELS
2721                         "<nick> :{[@|+]<channel><space>}"
2722
2723                 - Replies 311 - 313, 317 - 319 are all replies
2724                   generated in response to a WHOIS message.  Given that
2725                   there are enough parameters present, the answering
2726                   server must either formulate a reply out of the above
2727                   numerics (if the query nick is found) or return an
2728                   error reply.  The '*' in RPL_WHOISUSER is there as
2729                   the literal character and not as a wild card.  For
2730                   each reply set, only RPL_WHOISCHANNELS may appear
2731                   more than once (for long lists of channel names).
2732                   The '@' and '+' characters next to the channel name
2733                   indicate whether a client is a channel operator or
2734                   has been granted permission to speak on a moderated
2735                   channel.  The RPL_ENDOFWHOIS reply is used to mark
2736                   the end of processing a WHOIS message.
2737
2738         314     RPL_WHOWASUSER
2739                         "<nick> <user> <host> * :<real name>"
2740         369     RPL_ENDOFWHOWAS
2741                         "<nick> :End of WHOWAS"
2742
2743                 - When replying to a WHOWAS message, a server must use
2744                   the replies RPL_WHOWASUSER, RPL_WHOISSERVER or
2745                   ERR_WASNOSUCHNICK for each nickname in the presented
2746
2747
2748
2749 Oikarinen & Reed                                               [Page 49]
2750 \f
2751 RFC 1459              Internet Relay Chat Protocol              May 1993
2752
2753
2754                   list.  At the end of all reply batches, there must
2755                   be RPL_ENDOFWHOWAS (even if there was only one reply
2756                   and it was an error).
2757
2758         321     RPL_LISTSTART
2759                         "Channel :Users  Name"
2760         322     RPL_LIST
2761                         "<channel> <# visible> :<topic>"
2762         323     RPL_LISTEND
2763                         ":End of /LIST"
2764
2765                 - Replies RPL_LISTSTART, RPL_LIST, RPL_LISTEND mark
2766                   the start, actual replies with data and end of the
2767                   server's response to a LIST command.  If there are
2768                   no channels available to return, only the start
2769                   and end reply must be sent.
2770
2771         324     RPL_CHANNELMODEIS
2772                         "<channel> <mode> <mode params>"
2773
2774         331     RPL_NOTOPIC
2775                         "<channel> :No topic is set"
2776         332     RPL_TOPIC
2777                         "<channel> :<topic>"
2778
2779                 - When sending a TOPIC message to determine the
2780                   channel topic, one of two replies is sent.  If
2781                   the topic is set, RPL_TOPIC is sent back else
2782                   RPL_NOTOPIC.
2783
2784         341     RPL_INVITING
2785                         "<channel> <nick>"
2786
2787                 - Returned by the server to indicate that the
2788                   attempted INVITE message was successful and is
2789                   being passed onto the end client.
2790
2791         342     RPL_SUMMONING
2792                         "<user> :Summoning user to IRC"
2793
2794                 - Returned by a server answering a SUMMON message to
2795                   indicate that it is summoning that user.
2796
2797         351     RPL_VERSION
2798                         "<version>.<debuglevel> <server> :<comments>"
2799
2800                 - Reply by the server showing its version details.
2801                   The <version> is the version of the software being
2802
2803
2804
2805 Oikarinen & Reed                                               [Page 50]
2806 \f
2807 RFC 1459              Internet Relay Chat Protocol              May 1993
2808
2809
2810                   used (including any patchlevel revisions) and the
2811                   <debuglevel> is used to indicate if the server is
2812                   running in "debug mode".
2813
2814                   The "comments" field may contain any comments about
2815                   the version or further version details.
2816
2817         352     RPL_WHOREPLY
2818                         "<channel> <user> <host> <server> <nick> \
2819                          <H|G>[*][@|+] :<hopcount> <real name>"
2820         315     RPL_ENDOFWHO
2821                         "<name> :End of /WHO list"
2822
2823                 - The RPL_WHOREPLY and RPL_ENDOFWHO pair are used
2824                   to answer a WHO message.  The RPL_WHOREPLY is only
2825                   sent if there is an appropriate match to the WHO
2826                   query.  If there is a list of parameters supplied
2827                   with a WHO message, a RPL_ENDOFWHO must be sent
2828                   after processing each list item with <name> being
2829                   the item.
2830
2831         353     RPL_NAMREPLY
2832                         "<channel> :[[@|+]<nick> [[@|+]<nick> [...]]]"
2833         366     RPL_ENDOFNAMES
2834                         "<channel> :End of /NAMES list"
2835
2836                 - To reply to a NAMES message, a reply pair consisting
2837                   of RPL_NAMREPLY and RPL_ENDOFNAMES is sent by the
2838                   server back to the client.  If there is no channel
2839                   found as in the query, then only RPL_ENDOFNAMES is
2840                   returned.  The exception to this is when a NAMES
2841                   message is sent with no parameters and all visible
2842                   channels and contents are sent back in a series of
2843                   RPL_NAMEREPLY messages with a RPL_ENDOFNAMES to mark
2844                   the end.
2845
2846         364     RPL_LINKS
2847                         "<mask> <server> :<hopcount> <server info>"
2848         365     RPL_ENDOFLINKS
2849                         "<mask> :End of /LINKS list"
2850
2851                 - In replying to the LINKS message, a server must send
2852                   replies back using the RPL_LINKS numeric and mark the
2853                   end of the list using an RPL_ENDOFLINKS reply.
2854
2855         367     RPL_BANLIST
2856                         "<channel> <banid>"
2857         368     RPL_ENDOFBANLIST
2858
2859
2860
2861 Oikarinen & Reed                                               [Page 51]
2862 \f
2863 RFC 1459              Internet Relay Chat Protocol              May 1993
2864
2865
2866                         "<channel> :End of channel ban list"
2867
2868                 - When listing the active 'bans' for a given channel,
2869                   a server is required to send the list back using the
2870                   RPL_BANLIST and RPL_ENDOFBANLIST messages.  A separate
2871                   RPL_BANLIST is sent for each active banid.  After the
2872                   banids have been listed (or if none present) a
2873                   RPL_ENDOFBANLIST must be sent.
2874
2875         371     RPL_INFO
2876                         ":<string>"
2877         374     RPL_ENDOFINFO
2878                         ":End of /INFO list"
2879
2880                 - A server responding to an INFO message is required to
2881                   send all its 'info' in a series of RPL_INFO messages
2882                   with a RPL_ENDOFINFO reply to indicate the end of the
2883                   replies.
2884
2885         375     RPL_MOTDSTART
2886                         ":- <server> Message of the day - "
2887         372     RPL_MOTD
2888                         ":- <text>"
2889         376     RPL_ENDOFMOTD
2890                         ":End of /MOTD command"
2891
2892                 - When responding to the MOTD message and the MOTD file
2893                   is found, the file is displayed line by line, with
2894                   each line no longer than 80 characters, using
2895                   RPL_MOTD format replies.  These should be surrounded
2896                   by a RPL_MOTDSTART (before the RPL_MOTDs) and an
2897                   RPL_ENDOFMOTD (after).
2898
2899         381     RPL_YOUREOPER
2900                         ":You are now an IRC operator"
2901
2902                 - RPL_YOUREOPER is sent back to a client which has
2903                   just successfully issued an OPER message and gained
2904                   operator status.
2905
2906         382     RPL_REHASHING
2907                         "<config file> :Rehashing"
2908
2909                 - If the REHASH option is used and an operator sends
2910                   a REHASH message, an RPL_REHASHING is sent back to
2911                   the operator.
2912
2913         391     RPL_TIME
2914
2915
2916
2917 Oikarinen & Reed                                               [Page 52]
2918 \f
2919 RFC 1459              Internet Relay Chat Protocol              May 1993
2920
2921
2922                         "<server> :<string showing server's local time>"
2923
2924                 - When replying to the TIME message, a server must send
2925                   the reply using the RPL_TIME format above.  The string
2926                   showing the time need only contain the correct day and
2927                   time there.  There is no further requirement for the
2928                   time string.
2929
2930         392     RPL_USERSSTART
2931                         ":UserID   Terminal  Host"
2932         393     RPL_USERS
2933                         ":%-8s %-9s %-8s"
2934         394     RPL_ENDOFUSERS
2935                         ":End of users"
2936         395     RPL_NOUSERS
2937                         ":Nobody logged in"
2938
2939                 - If the USERS message is handled by a server, the
2940                   replies RPL_USERSTART, RPL_USERS, RPL_ENDOFUSERS and
2941                   RPL_NOUSERS are used.  RPL_USERSSTART must be sent
2942                   first, following by either a sequence of RPL_USERS
2943                   or a single RPL_NOUSER.  Following this is
2944                   RPL_ENDOFUSERS.
2945
2946         200     RPL_TRACELINK
2947                         "Link <version & debug level> <destination> \
2948                          <next server>"
2949         201     RPL_TRACECONNECTING
2950                         "Try. <class> <server>"
2951         202     RPL_TRACEHANDSHAKE
2952                         "H.S. <class> <server>"
2953         203     RPL_TRACEUNKNOWN
2954                         "???? <class> [<client IP address in dot form>]"
2955         204     RPL_TRACEOPERATOR
2956                         "Oper <class> <nick>"
2957         205     RPL_TRACEUSER
2958                         "User <class> <nick>"
2959         206     RPL_TRACESERVER
2960                         "Serv <class> <int>S <int>C <server> \
2961                          <nick!user|*!*>@<host|server>"
2962         208     RPL_TRACENEWTYPE
2963                         "<newtype> 0 <client name>"
2964         261     RPL_TRACELOG
2965                         "File <logfile> <debug level>"
2966
2967                 - The RPL_TRACE* are all returned by the server in
2968                   response to the TRACE message.  How many are
2969                   returned is dependent on the the TRACE message and
2970
2971
2972
2973 Oikarinen & Reed                                               [Page 53]
2974 \f
2975 RFC 1459              Internet Relay Chat Protocol              May 1993
2976
2977
2978                   whether it was sent by an operator or not.  There
2979                   is no predefined order for which occurs first.
2980                   Replies RPL_TRACEUNKNOWN, RPL_TRACECONNECTING and
2981                   RPL_TRACEHANDSHAKE are all used for connections
2982                   which have not been fully established and are either
2983                   unknown, still attempting to connect or in the
2984                   process of completing the 'server handshake'.
2985                   RPL_TRACELINK is sent by any server which handles
2986                   a TRACE message and has to pass it on to another
2987                   server.  The list of RPL_TRACELINKs sent in
2988                   response to a TRACE command traversing the IRC
2989                   network should reflect the actual connectivity of
2990                   the servers themselves along that path.
2991                   RPL_TRACENEWTYPE is to be used for any connection
2992                   which does not fit in the other categories but is
2993                   being displayed anyway.
2994
2995         211     RPL_STATSLINKINFO
2996                         "<linkname> <sendq> <sent messages> \
2997                          <sent bytes> <received messages> \
2998                          <received bytes> <time open>"
2999         212     RPL_STATSCOMMANDS
3000                         "<command> <count>"
3001         213     RPL_STATSCLINE
3002                         "C <host> * <name> <port> <class>"
3003         214     RPL_STATSNLINE
3004                         "N <host> * <name> <port> <class>"
3005         215     RPL_STATSILINE
3006                         "I <host> * <host> <port> <class>"
3007         216     RPL_STATSKLINE
3008                         "K <host> * <username> <port> <class>"
3009         218     RPL_STATSYLINE
3010                         "Y <class> <ping frequency> <connect \
3011                          frequency> <max sendq>"
3012         219     RPL_ENDOFSTATS
3013                         "<stats letter> :End of /STATS report"
3014         241     RPL_STATSLLINE
3015                         "L <hostmask> * <servername> <maxdepth>"
3016         242     RPL_STATSUPTIME
3017                         ":Server Up %d days %d:%02d:%02d"
3018         243     RPL_STATSOLINE
3019                         "O <hostmask> * <name>"
3020         244     RPL_STATSHLINE
3021                         "H <hostmask> * <servername>"
3022
3023         221     RPL_UMODEIS
3024                         "<user mode string>"
3025
3026
3027
3028
3029 Oikarinen & Reed                                               [Page 54]
3030 \f
3031 RFC 1459              Internet Relay Chat Protocol              May 1993
3032
3033
3034                         - To answer a query about a client's own mode,
3035                           RPL_UMODEIS is sent back.
3036
3037         251     RPL_LUSERCLIENT
3038                         ":There are <integer> users and <integer> \
3039                          invisible on <integer> servers"
3040         252     RPL_LUSEROP
3041                         "<integer> :operator(s) online"
3042         253     RPL_LUSERUNKNOWN
3043                         "<integer> :unknown connection(s)"
3044         254     RPL_LUSERCHANNELS
3045                         "<integer> :channels formed"
3046         255     RPL_LUSERME
3047                         ":I have <integer> clients and <integer> \
3048                           servers"
3049
3050                         - In processing an LUSERS message, the server
3051                           sends a set of replies from RPL_LUSERCLIENT,
3052                           RPL_LUSEROP, RPL_USERUNKNOWN,
3053                           RPL_LUSERCHANNELS and RPL_LUSERME.  When
3054                           replying, a server must send back
3055                           RPL_LUSERCLIENT and RPL_LUSERME.  The other
3056                           replies are only sent back if a non-zero count
3057                           is found for them.
3058
3059         256     RPL_ADMINME
3060                         "<server> :Administrative info"
3061         257     RPL_ADMINLOC1
3062                         ":<admin info>"
3063         258     RPL_ADMINLOC2
3064                         ":<admin info>"
3065         259     RPL_ADMINEMAIL
3066                         ":<admin info>"
3067
3068                         - When replying to an ADMIN message, a server
3069                           is expected to use replies RLP_ADMINME
3070                           through to RPL_ADMINEMAIL and provide a text
3071                           message with each.  For RPL_ADMINLOC1 a
3072                           description of what city, state and country
3073                           the server is in is expected, followed by
3074                           details of the university and department
3075                           (RPL_ADMINLOC2) and finally the administrative
3076                           contact for the server (an email address here
3077                           is required) in RPL_ADMINEMAIL.
3078
3079
3080
3081
3082
3083
3084
3085 Oikarinen & Reed                                               [Page 55]
3086 \f
3087 RFC 1459              Internet Relay Chat Protocol              May 1993
3088
3089
3090 6.3 Reserved numerics.
3091
3092    These numerics are not described above since they fall into one of
3093    the following categories:
3094
3095         1. no longer in use;
3096
3097         2. reserved for future planned use;
3098
3099         3. in current use but are part of a non-generic 'feature' of
3100            the current IRC server.
3101
3102         209     RPL_TRACECLASS          217     RPL_STATSQLINE
3103         231     RPL_SERVICEINFO         232     RPL_ENDOFSERVICES
3104         233     RPL_SERVICE             234     RPL_SERVLIST
3105         235     RPL_SERVLISTEND
3106         316     RPL_WHOISCHANOP         361     RPL_KILLDONE
3107         362     RPL_CLOSING             363     RPL_CLOSEEND
3108         373     RPL_INFOSTART           384     RPL_MYPORTIS
3109         466     ERR_YOUWILLBEBANNED     476     ERR_BADCHANMASK
3110         492     ERR_NOSERVICEHOST
3111
3112 7. Client and server authentication
3113
3114    Clients and servers are both subject to the same level of
3115    authentication.  For both, an IP number to hostname lookup (and
3116    reverse check on this) is performed for all connections made to the
3117    server.  Both connections are then subject to a password check (if
3118    there is a password set for that connection).  These checks are
3119    possible on all connections although the password check is only
3120    commonly used with servers.
3121
3122    An additional check that is becoming of more and more common is that
3123    of the username responsible for making the connection.  Finding the
3124    username of the other end of the connection typically involves
3125    connecting to an authentication server such as IDENT as described in
3126    RFC 1413.
3127
3128    Given that without passwords it is not easy to reliably determine who
3129    is on the other end of a network connection, use of passwords is
3130    strongly recommended on inter-server connections in addition to any
3131    other measures such as using an ident server.
3132
3133 8. Current implementations
3134
3135    The only current implementation of this protocol is the IRC server,
3136    version 2.8. Earlier versions may implement some or all of the
3137    commands described by this document with NOTICE messages replacing
3138
3139
3140
3141 Oikarinen & Reed                                               [Page 56]
3142 \f
3143 RFC 1459              Internet Relay Chat Protocol              May 1993
3144
3145
3146    many of the numeric replies.  Unfortunately, due to backward
3147    compatibility requirements, the implementation of some parts of this
3148    document varies with what is laid out.  On notable difference is:
3149
3150         * recognition that any LF or CR anywhere in a message marks the
3151           end of that message (instead of requiring CR-LF);
3152
3153    The rest of this section deals with issues that are mostly of
3154    importance to those who wish to implement a server but some parts
3155    also apply directly to clients as well.
3156
3157 8.1 Network protocol: TCP - why it is best used here.
3158
3159    IRC has been implemented on top of TCP since TCP supplies a reliable
3160    network protocol which is well suited to this scale of conferencing.
3161    The use of multicast IP is an alternative, but it is not widely
3162    available or supported at the present time.
3163
3164 8.1.1 Support of Unix sockets
3165
3166    Given that Unix domain sockets allow listen/connect operations, the
3167    current implementation can be configured to listen and accept both
3168    client and server connections on a Unix domain socket.  These are
3169    recognized as sockets where the hostname starts with a '/'.
3170
3171    When providing any information about the connections on a Unix domain
3172    socket, the server is required to supplant the actual hostname in
3173    place of the pathname unless the actual socket name is being asked
3174    for.
3175
3176 8.2 Command Parsing
3177
3178    To provide useful 'non-buffered' network IO for clients and servers,
3179    each connection is given its own private 'input buffer' in which the
3180    results of the most recent read and parsing are kept.  A buffer size
3181    of 512 bytes is used so as to hold 1 full message, although, this
3182    will usually hold several commands.  The private buffer is parsed
3183    after every read operation for valid messages.  When dealing with
3184    multiple messages from one client in the buffer, care should be taken
3185    in case one happens to cause the client to be 'removed'.
3186
3187 8.3 Message delivery
3188
3189    It is common to find network links saturated or hosts to which you
3190    are sending data unable to send data.  Although Unix typically
3191    handles this through the TCP window and internal buffers, the server
3192    often has large amounts of data to send (especially when a new
3193    server-server link forms) and the small buffers provided in the
3194
3195
3196
3197 Oikarinen & Reed                                               [Page 57]
3198 \f
3199 RFC 1459              Internet Relay Chat Protocol              May 1993
3200
3201
3202    kernel are not enough for the outgoing queue.  To alleviate this
3203    problem, a "send queue" is used as a FIFO queue for data to be sent.
3204    A typical "send queue" may grow to 200 Kbytes on a large IRC network
3205    with a slow network connection when a new server connects.
3206
3207    When polling its connections, a server will first read and parse all
3208    incoming data, queuing any data to be sent out. When all available
3209    input is processed, the queued data is sent. This reduces the number
3210    of write() system calls and helps TCP make bigger packets.
3211
3212 8.4 Connection 'Liveness'
3213
3214    To detect when a connection has died or become unresponsive, the
3215    server must ping each of its connections that it doesn't get a
3216    response from in a given amount of time.
3217
3218    If a connection doesn't respond in time, its connection is closed
3219    using the appropriate procedures.  A connection is also dropped if
3220    its sendq grows beyond the maximum allowed, because it is better to
3221    close a slow connection than have a server process block.
3222
3223 8.5 Establishing a server to client connection
3224
3225    Upon connecting to an IRC server, a client is sent the MOTD (if
3226    present) as well as the current user/server count (as per the LUSER
3227    command).  The server is also required to give an unambiguous message
3228    to the client which states its name and version as well as any other
3229    introductory messages which may be deemed appropriate.
3230
3231    After dealing with this, the server must then send out the new user's
3232    nickname and other information as supplied by itself (USER command)
3233    and as the server could discover (from DNS/authentication servers).
3234    The server must send this information out with NICK first followed by
3235    USER.
3236
3237 8.6 Establishing a server-server connection.
3238
3239    The process of establishing of a server-to-server connection is
3240    fraught with danger since there are many possible areas where
3241    problems can occur - the least of which are race conditions.
3242
3243    After a server has received a connection following by a PASS/SERVER
3244    pair which were recognised as being valid, the server should then
3245    reply with its own PASS/SERVER information for that connection as
3246    well as all of the other state information it knows about as
3247    described below.
3248
3249    When the initiating server receives a PASS/SERVER pair, it too then
3250
3251
3252
3253 Oikarinen & Reed                                               [Page 58]
3254 \f
3255 RFC 1459              Internet Relay Chat Protocol              May 1993
3256
3257
3258    checks that the server responding is authenticated properly before
3259    accepting the connection to be that server.
3260
3261 8.6.1 Server exchange of state information when connecting
3262
3263    The order of state information being exchanged between servers is
3264    essential.  The required order is as follows:
3265
3266         * all known other servers;
3267
3268         * all known user information;
3269
3270         * all known channel information.
3271
3272    Information regarding servers is sent via extra SERVER messages, user
3273    information with NICK/USER/MODE/JOIN messages and channels with MODE
3274    messages.
3275
3276    NOTE: channel topics are *NOT* exchanged here because the TOPIC
3277    command overwrites any old topic information, so at best, the two
3278    sides of the connection would exchange topics.
3279
3280    By passing the state information about servers first, any collisions
3281    with servers that already exist occur before nickname collisions due
3282    to a second server introducing a particular nickname.  Due to the IRC
3283    network only being able to exist as an acyclic graph, it may be
3284    possible that the network has already reconnected in another
3285    location, the place where the collision occurs indicating where the
3286    net needs to split.
3287
3288 8.7 Terminating server-client connections
3289
3290    When a client connection closes, a QUIT message is generated on
3291    behalf of the client by the server to which the client connected.  No
3292    other message is to be generated or used.
3293
3294 8.8 Terminating server-server connections
3295
3296    If a server-server connection is closed, either via a remotely
3297    generated SQUIT or 'natural' causes, the rest of the connected IRC
3298    network must have its information updated with by the server which
3299    detected the closure.  The server then sends a list of SQUITs (one
3300    for each server behind that connection) and a list of QUITs (again,
3301    one for each client behind that connection).
3302
3303
3304
3305
3306
3307
3308
3309 Oikarinen & Reed                                               [Page 59]
3310 \f
3311 RFC 1459              Internet Relay Chat Protocol              May 1993
3312
3313
3314 8.9 Tracking nickname changes
3315
3316    All IRC servers are required to keep a history of recent nickname
3317    changes.  This is required to allow the server to have a chance of
3318    keeping in touch of things when nick-change race conditions occur
3319    with commands which manipulate them.  Commands which must trace nick
3320    changes are:
3321
3322         * KILL (the nick being killed)
3323
3324         * MODE (+/- o,v)
3325
3326         * KICK (the nick being kicked)
3327
3328    No other commands are to have nick changes checked for.
3329
3330    In the above cases, the server is required to first check for the
3331    existence of the nickname, then check its history to see who that
3332    nick currently belongs to (if anyone!).  This reduces the chances of
3333    race conditions but they can still occur with the server ending up
3334    affecting the wrong client.  When performing a change trace for an
3335    above command it is recommended that a time range be given and
3336    entries which are too old ignored.
3337
3338    For a reasonable history, a server should be able to keep previous
3339    nickname for every client it knows about if they all decided to
3340    change.  This size is limited by other factors (such as memory, etc).
3341
3342 8.10 Flood control of clients
3343
3344    With a large network of interconnected IRC servers, it is quite easy
3345    for any single client attached to the network to supply a continuous
3346    stream of messages that result in not only flooding the network, but
3347    also degrading the level of service provided to others.  Rather than
3348    require every 'victim' to be provide their own protection, flood
3349    protection was written into the server and is applied to all clients
3350    except services.  The current algorithm is as follows:
3351
3352         * check to see if client's `message timer' is less than
3353           current time (set to be equal if it is);
3354
3355         * read any data present from the client;
3356
3357         * while the timer is less than ten seconds ahead of the current
3358           time, parse any present messages and penalize the client by
3359           2 seconds for each message;
3360
3361    which in essence means that the client may send 1 message every 2
3362
3363
3364
3365 Oikarinen & Reed                                               [Page 60]
3366 \f
3367 RFC 1459              Internet Relay Chat Protocol              May 1993
3368
3369
3370    seconds without being adversely affected.
3371
3372 8.11 Non-blocking lookups
3373
3374    In a real-time environment, it is essential that a server process do
3375    as little waiting as possible so that all the clients are serviced
3376    fairly.  Obviously this requires non-blocking IO on all network
3377    read/write operations.  For normal server connections, this was not
3378    difficult, but there are other support operations that may cause the
3379    server to block (such as disk reads).  Where possible, such activity
3380    should be performed with a short timeout.
3381
3382 8.11.1 Hostname (DNS) lookups
3383
3384    Using the standard resolver libraries from Berkeley and others has
3385    meant large delays in some cases where replies have timed out.  To
3386    avoid this, a separate set of DNS routines were written which were
3387    setup for non-blocking IO operations and then polled from within the
3388    main server IO loop.
3389
3390 8.11.2 Username (Ident) lookups
3391
3392    Although there are numerous ident libraries for use and inclusion
3393    into other programs, these caused problems since they operated in a
3394    synchronous manner and resulted in frequent delays.  Again the
3395    solution was to write a set of routines which would cooperate with
3396    the rest of the server and work using non-blocking IO.
3397
3398 8.12 Configuration File
3399
3400    To provide a flexible way of setting up and running the server, it is
3401    recommended that a configuration file be used which contains
3402    instructions to the server on the following:
3403
3404         * which hosts to accept client connections from;
3405
3406         * which hosts to allow to connect as servers;
3407
3408         * which hosts to connect to (both actively and
3409           passively);
3410
3411         * information about where the server is (university,
3412           city/state, company are examples of this);
3413
3414         * who is responsible for the server and an email address
3415           at which they can be contacted;
3416
3417         * hostnames and passwords for clients which wish to be given
3418
3419
3420
3421 Oikarinen & Reed                                               [Page 61]
3422 \f
3423 RFC 1459              Internet Relay Chat Protocol              May 1993
3424
3425
3426           access to restricted operator commands.
3427
3428    In specifying hostnames, both domain names and use of the 'dot'
3429    notation (127.0.0.1) should both be accepted.  It must be possible to
3430    specify the password to be used/accepted for all outgoing and
3431    incoming connections (although the only outgoing connections are
3432    those to other servers).
3433
3434    The above list is the minimum requirement for any server which wishes
3435    to make a connection with another server.  Other items which may be
3436    of use are:
3437
3438         * specifying which servers other server may introduce;
3439
3440         * how deep a server branch is allowed to become;
3441
3442         * hours during which clients may connect.
3443
3444 8.12.1 Allowing clients to connect
3445
3446    A server should use some sort of 'access control list' (either in the
3447    configuration file or elsewhere) that is read at startup and used to
3448    decide what hosts clients may use to connect to it.
3449
3450    Both 'deny' and 'allow' should be implemented to provide the required
3451    flexibility for host access control.
3452
3453 8.12.2 Operators
3454
3455    The granting of operator privileges to a disruptive person can have
3456    dire consequences for the well-being of the IRC net in general due to
3457    the powers given to them.  Thus, the acquisition of such powers
3458    should not be very easy.  The current setup requires two 'passwords'
3459    to be used although one of them is usually easy guessed.  Storage of
3460    oper passwords in configuration files is preferable to hard coding
3461    them in and should be stored in a crypted format (ie using crypt(3)
3462    from Unix) to prevent easy theft.
3463
3464 8.12.3 Allowing servers to connect
3465
3466    The interconnection of server is not a trivial matter: a bad
3467    connection can have a large impact on the usefulness of IRC.  Thus,
3468    each server should have a list of servers to which it may connect and
3469    which servers may connect to it.  Under no circumstances should a
3470    server allow an arbitrary host to connect as a server.  In addition
3471    to which servers may and may not connect, the configuration file
3472    should also store the password and other characteristics of that
3473    link.
3474
3475
3476
3477 Oikarinen & Reed                                               [Page 62]
3478 \f
3479 RFC 1459              Internet Relay Chat Protocol              May 1993
3480
3481
3482 8.12.4 Administrivia
3483
3484    To provide accurate and valid replies to the ADMIN command (see
3485    section 4.3.7), the server should find the relevant details in the
3486    configuration.
3487
3488 8.13 Channel membership
3489
3490    The current server allows any registered local user to join upto 10
3491    different channels.  There is no limit imposed on non-local users so
3492    that the server remains (reasonably) consistant with all others on a
3493    channel membership basis
3494
3495 9. Current problems
3496
3497    There are a number of recognized problems with this protocol, all  of
3498    which  hope to be solved sometime in the near future during its
3499    rewrite.  Currently, work is underway to find working solutions to
3500    these problems.
3501
3502 9.1 Scalability
3503
3504    It is widely recognized that this protocol does not scale
3505    sufficiently well when used in a large arena.  The main problem comes
3506    from the requirement that all servers know about all other servers
3507    and users and that information regarding them be updated as soon as
3508    it changes.  It is also desirable to keep the number of servers low
3509    so that the path length between any two points is kept minimal and
3510    the spanning tree as strongly branched as possible.
3511
3512 9.2 Labels
3513
3514    The current IRC protocol has 3 types of labels: the nickname, the
3515    channel name and the server name.  Each of the three types has its
3516    own domain and no duplicates are allowed inside that domain.
3517    Currently, it is possible for users to pick the label for any of the
3518    three, resulting in collisions.  It is widely recognized that this
3519    needs reworking, with a plan for unique names for channels and nicks
3520    that don't collide being desirable as well as a solution allowing a
3521    cyclic tree.
3522
3523 9.2.1 Nicknames
3524
3525    The idea of the nickname on IRC is very convenient for users to use
3526    when talking to each other outside of a channel, but there is only a
3527    finite nickname space and being what they are, its not uncommon for
3528    several people to want to use the same nick.  If a nickname is chosen
3529    by two people using this protocol, either one will not succeed or
3530
3531
3532
3533 Oikarinen & Reed                                               [Page 63]
3534 \f
3535 RFC 1459              Internet Relay Chat Protocol              May 1993
3536
3537
3538    both will removed by use of KILL (4.6.1).
3539
3540 9.2.2 Channels
3541
3542    The current channel layout requires that all servers know about all
3543    channels, their inhabitants and properties.  Besides not scaling
3544    well, the issue of privacy is also a concern.  A collision of
3545    channels is treated as an inclusive event (both people who create the
3546    new channel are considered to be members of it) rather than an
3547    exclusive one such as used to solve nickname collisions.
3548
3549 9.2.3 Servers
3550
3551    Although the number of servers is usually small relative to the
3552    number of users and channels, they two currently required to be known
3553    globally, either each one separately or hidden behind a mask.
3554
3555 9.3 Algorithms
3556
3557    In some places within the server code, it has not  been  possible  to
3558    avoid  N^2  algorithms  such  as  checking  the channel list of a set
3559    of clients.
3560
3561    In current server versions, there are no database consistency checks,
3562    each server assumes that a neighbouring server is correct.  This
3563    opens the door to large problems if a connecting server is buggy or
3564    otherwise tries to introduce contradictions to the existing net.
3565
3566    Currently, because of the lack of unique internal and global labels,
3567    there are a multitude of race conditions that exist.  These race
3568    conditions generally arise from the problem of it taking time for
3569    messages to traverse and effect the IRC network.  Even by changing to
3570    unique labels, there are problems with channel-related commands being
3571    disrupted.
3572
3573 10. Current support and availability
3574
3575            Mailing lists for IRC related discussion:
3576                 Future protocol: ircd-three-request@eff.org
3577                 General discussion: operlist-request@eff.org
3578
3579            Software implemenations
3580                 cs.bu.edu:/irc
3581                 nic.funet.fi:/pub/irc
3582                 coombs.anu.edu.au:/pub/irc
3583
3584            Newsgroup: alt.irc
3585
3586
3587
3588
3589 Oikarinen & Reed                                               [Page 64]
3590 \f
3591 RFC 1459              Internet Relay Chat Protocol              May 1993
3592
3593
3594 Security Considerations
3595
3596    Security issues are discussed in sections 4.1, 4.1.1, 4.1.3, 5.5, and
3597    7.
3598
3599 12. Authors' Addresses
3600
3601    Jarkko Oikarinen
3602    Tuirantie 17 as 9
3603    90500 OULU
3604    FINLAND
3605
3606    Email: jto@tolsun.oulu.fi
3607
3608
3609    Darren Reed
3610    4 Pateman Street
3611    Watsonia, Victoria 3087
3612    Australia
3613
3614    Email: avalon@coombs.anu.edu.au
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645 Oikarinen & Reed                                               [Page 65]
3646 \f