unrealircd

- supernets unrealircd source & configuration
git clone git://git.acid.vegas/unrealircd.git
Log | Files | Refs | Archive | README | LICENSE

005.txt (12385B)

      1 Numeric 005 Documentation
      2 (c) 2002-2005 codemastr (Dominick Meglio) [codemastr@unrealircd.com]
      3 (c) 2005-2009 syzop (Bram Matthys) [syzop@vulnscan.org]
      4 
      5 Numeric 005 allows the server to inform the client of any protocol specific features in the
      6 IRCd.  The numeric is sent at connection time immediately after numeric 004. Additionally
      7 the numeric is sent when a /version request is made by a local user, for remote users
      8 numeric 105 is used but contains the same information.
      9 
     10 Due to the limit imposed by RFC1459 on both the buffer size (512) and the amount of
     11 parameters that can be sent in a single command (15) a total of 13 parameters may be
     12 specified in each 005. Because of this, a client must be able to accept multiple 005s
     13 consecutively. The format for the 005 message is as follows:
     14 
     15 ":" <servername> "005" SPACE <nickname> SPACE <token[=value]> SPACE ... ":are supported
     16 by this server"
     17 
     18 Currently UnrealIRCd supports several tokens that are included in numeric 005. A list of
     19 all tokens, their respective value and a brief description are listed below.
     20 
     21 UnrealIRCd attempts to follow the proposed ISupport standard as much as possible. UnrealIRCd
     22 only ignores the standard in one regard, the TARGMAX token. This token is believed to be 
     23 impractical and technically impossible to correctly implement due to existing limitations
     24 in the standard. Therefore, this token is not currently supported. 
     25 
     26 UnrealIRCd does additionally provide a few tokens which are not specified in the standard, these
     27 include: HCN, AWAYLEN, WATCH, SILENCE, EXTBAN, ELIST, CMDS, NAMESX, UHNAMES, and WATCHOPTS.
     28 UnrealIRCd also maintains a few legacy tokens such as MAXCHANNELS and WALLCHOPS to ensure
     29 compatibility until the ISupport standard is more widely accepted by clients.
     30 
     31 Token         Value           Default Value                Description
     32 ------------------------------------------------------------------------------------------------
     33 MAP           none            none                         Informs the client that the /map 
     34                                                            command is present. [Obsolete]
     35 
     36 KNOCK         none            none                         Informs the client that the /knock
     37                                                            command is present. [Obsolete]
     38 
     39 SAFELIST      none            none                         The LIST command is sent in 
     40                                                            multiple iterations so that the
     41                                                            client's queue does not get filled
     42                                                            causing the user to be killed.
     43 
     44 HCN           none            none                         The server supports the HCN
     45                                                            (Hybrid Connect Notice) protocol.
     46 
     47 MAXCHANNELS   number          10                           The maximum number of channels a
     48                                                            user may join. [Deprecated]
     49 
     50 MAXBANS       number          60                           The maximum number of bans that
     51                                                            may be placed for a channel.
     52                                                            [Obsolete]
     53 
     54 NICKLEN       number          30                           Maximum length of a user's
     55                                                            nickname.
     56 
     57 TOPICLEN      number          307                          Maximum length of a channel's
     58                                                            topic.
     59 
     60 KICKLEN       number          307                          Maximum length of a kick reason.
     61 
     62 MAXTARGETS    number          20                           Maximum targets for the PRIVMSG
     63                                                            command.
     64 
     65 AWAYLEN       number          307                          Maximum length of an away message.
     66 
     67 WALLCHOPS     none            none                         Indicates that you may use
     68                                                            NOTICE/PRIVMSG to send to +ohv by
     69                                                            using PRIVMSG/NOTICE [@|%|+]#channel.
     70                                                            [Deprecated]
     71  
     72 WATCH         number          128                          Indicates the presence of the
     73                                                            WATCH command and specifies the
     74                                                            maximum number of watch entries.
     75 
     76 SILENCE       number          15                           Indicates the maximum number of
     77                                                            entries on the silence list.
     78 
     79 MODES         number          13                           Indicates the number of channel
     80                                                            modes with parameters that may be
     81                                                            sent at one time.
     82 
     83 CHANTYPES     chars           #                            Indicates the prefixes available
     84                                                            for channels.
     85  
     86 PREFIX        (modes)prefixes (qaohv)~&@%+                 Indicates the modes on a channel
     87                                                            that corespond to the given
     88                                                            nickname prefixes.
     89 
     90 CHANMODES     A,B,C,D         be,kfL,lj,                   Specifies how each channel mode is
     91                               psmntirRcOAQKVHGCuzNSMT      set/unset. The A section specifies
     92                                                            modes that add a nick/mask to a
     93                                                            list. The B section specifies
     94                                                            modes that require a parameter
     95                                                            to be both set and unset. The C
     96                                                            section specifies modes that
     97                                                            only require a parameter to be
     98                                                            set, and the D section
     99                                                            specifies modes that require no
    100                                                            parameters.
    101 
    102 NETWORK       string          no default value             Specifies the name of the
    103                                                            network that the server is
    104                                                            connected to.
    105 
    106 CASEMAPPING   string          ascii                        Specifies what definition the
    107                                                            server uses when determining if
    108                                                            characters are upper/lowercase
    109                                                            of eachother.
    110 
    111 EXTBAN        prefix,types    ~,cqnr                       Specifies what extbans are
    112                                                            supported by the server. The prefix
    113                                                            defines which character indicates
    114                                                            an extban and the types defines
    115                                                            which extbans the server supports.
    116 
    117 ELIST         flags           MNUCT                        Specifies the set of extended LIST
    118                                                            options supported. The M flag 
    119                                                            indicates mask based searching,
    120                                                            the N flag indicates negative
    121                                                            mask based searching. The U flag
    122                                                            means support for user count
    123                                                            searching. The C flag allows channel
    124                                                            creation time searching, and the T
    125                                                            flag allows topic set time 
    126                                                            searching.
    127 
    128 CMDS          commands        MAP,KNOCK,DCCALLOW,USERIP    Specifies a series of commands that
    129                                                            can be useful for the client to know
    130                                                            exist as they may provide a more
    131                                                            efficient means for the client to
    132                                                            accomplish a specific task. This
    133                                                            token replaces the MAP and KNOCK
    134                                                            tokens.
    135 
    136 STATUSMSG     flags           ~&@%+                        Specifies the mode flags that may
    137                                                            prefix a channel name in a PRIVMSG
    138                                                            or NOTICE to limit who receives the
    139                                                            message to only those with a certain
    140                                                            level of access. This token will
    141                                                            replace the WALLCHOPS token.
    142 
    143 EXCEPTS       none            none                         Indicates that channel ban exceptions
    144                                                            (+e) are supported by the server.
    145 
    146 INVEX         none            none                         Indicates that channel invite
    147                                                            exceptions (+I) are supported by
    148                                                            the server.
    149 
    150 MAXLIST       mode:num,...    b:60,e:60,I:60               Specifies the maximum number of 
    151                                                            entries that may be added to a 
    152                                                            particular mode list (type A modes).
    153                                                            This token replaces MAXBANS.
    154 
    155 CHANLIMIT     pfx:num,...     #:10                         Specifies the maximum number of 
    156                                                            channels with the specified prefix
    157                                                            that a user may join at one time.
    158                                                            This token will replace MAXCHANNELS.
    159 
    160 CHANNELLEN    number          32                           Provides the maximum length of a
    161                                                            channel name that a user can create.
    162 
    163 NAMESX        none            none                         Indicates that extended /NAMES info
    164                                                            is available on this server. If the
    165                                                            client sends "PROTOCTL NAMESX" then
    166                                                            the server will, from then on, send
    167                                                            all channel rights in a NAMES reply
    168                                                            instead of only the highest right
    169                                                            (eg: @+Person instead of @Person).
    170 
    171 UHNAMES       none            none                         Indicates that (other) extended
    172                                                            /NAMES info is available on the
    173                                                            server. If the client sends
    174                                                            "PROTOCTL UHNAMES" then the server
    175                                                            will, from then on, send user@host
    176                                                            information in a NAMES reply
    177                                                            (eg: @nick!ident@hostname).
    178 
    179 WATCHOPTS     flags           A                            WATCH options supported. 'A' means
    180                                                            Away Notification is available.