doc/sgml/oper-guide/cmodes.sgml

   1   <chapter id="cmodes">
   2     <title>Cmodes</title>
   3     <sect1>
   4       <title>Meanings of channel modes</title>
   5       <sect2>
   6         <title>+b, channel ban</title>
   7         <para>
   8           Bans take one parameter which can take several forms.
   9           The most common form is +b nick!user@host.
  10           The wildcards * and ? are allowed, matching zero-or-more, and
  11           exactly-one characters respectively. The masks will be trimmed to fit the maximum allowable
  12           length for the relevant element.
  13           Bans are also checked against the IP address, even if it resolved or
  14           is spoofed.
  15           CIDR is supported, like *!*@10.0.0.0/8. This is most useful with
  16           IPv6.
  17           Bans are not checked against the real hostname behind any kind
  18           of spoof, except if host mangling is in use (e.g.
  19           <filename>extensions/ip_cloaking.so</filename>):
  20           if the user's host is mangled, their real hostname is checked
  21           additionally, and if a user has no spoof but could enable mangling,
  22           the mangled form of their hostname is checked additionally.
  23           Hence, it is not possible to evade bans by toggling
  24           host mangling.
  25         </para>
  26         <para>
  27           The second form (extban) is +b $type or +b $type:data.
  28           type is a single character (case insensitive) indicating the
  29           type of match, optionally preceded by a tilde (~) to negate the
  30           comparison. data depends on type. Each type is loaded as a module.
  31           The available types (if any)
  32           are listed in the EXTBAN token of the 005 (RPL_ISUPPORT) numeric.
  33           See <filename>doc/extban.txt</filename> in the source distribution
  34           for more information.
  35         </para>
  36         <para>
  37           If no parameter is given, the list of bans is returned. All users
  38           can use this form. The plus sign should also be omitted.
  39         </para>
  40         <para>
  41           Matching users will not be allowed to join the channel or knock
  42           on it. If they are already on the channel, they may not send to
  43           it or change their nick.
  44         </para>
  45       </sect2>
  46       <sect2>
  47         <title>+c, colour filter</title>
  48         <para>
  49           This cmode activates the colour filter for the channel. This filters out bold, underline,
  50           reverse video, beeps, mIRC colour codes, and ANSI escapes. Note that escape sequences will
  51           usually leave cruft sent to the channel, just without the escape characters themselves.
  52         </para>
  53       </sect2>
  54       <sect2>
  55         <title>+e, ban exemption</title>
  56         <para>
  57           This mode takes one parameter of the same form as bans, which
  58           overrides +b and +q bans for all clients it matches.
  59         </para>
  60         <para>
  61           This can be useful if it is necessary to ban an entire ISP
  62           due to persistent abuse, but some users from that ISP should
  63           still be allowed in. For example:
  64           /mode #channel +be *!*@*.example.com *!*someuser@host3.example.com
  65         </para>
  66         <para>
  67           Only channel operators can see +e changes or request the list.
  68         </para>
  69       </sect2>
  70       <sect2>
  71         <title>+f, channel forwarding</title>
  72         <para>
  73           This mode takes one parameter, the name of a channel (+f #channel). If the channel also has the
  74           +i cmode set, and somebody attempts to join without either being expliticly invited, or having
  75           an invex (+I), then they will instead join the channel named in the mode parameter. The client
  76           will also be sent a 470 numeric giving the original and target channels.
  77         </para>
  78         <para>
  79           Users are similarly forwarded if the +j cmode is set and their attempt to join is throttled,
  80           if +l is set and there are already too many users in the channel
  81           or if +r is set and they are not identified.
  82         </para>
  83         <para>
  84           Forwards may only be set to +F channels, or to channels the setter
  85           has ops in.
  86         </para>
  87         <para>
  88           Without parameter (/mode #channel f or /mode #channel +f) the
  89           forward channel is returned. This form also works off channel.
  90         </para>
  91       </sect2>
  92       <sect2>
  93         <title>+F, allow anybody to forward to this</title>
  94         <para>
  95           When this mode is set, anybody may set a forward from a channel
  96           they have ops in to this channel. Otherwise they have to have ops
  97           in this channel.
  98         </para>
  99       </sect2>
 100       <sect2>
 101         <title>+g, allow anybody to invite</title>
 102         <para>
 103           When this mode is set, anybody may use the INVITE command on the channel in question. When it
 104           is unset, only channel operators may use the INVITE command.
 105         </para>
 106         <para>
 107           When this mode is set together with +i, all channel members can influence who can join.
 108         </para>
 109       </sect2>
 110       <sect2>
 111         <title>+i, invite only</title>
 112         <para>
 113           When this cmode is set, no client can join the channel unless they have an invex (+I) or are
 114           invited with the INVITE command.
 115         </para>
 116       </sect2>
 117       <sect2>
 118         <title>+I, invite exception (invex)</title>
 119         <para>
 120           This mode takes one parameter of the same form as bans. Matching
 121           clients do not need to be invited to join the channel when it is invite-only (+i).
 122         </para>
 123         <para>
 124           Only channel operators can see +I changes or request the list.
 125         </para>
 126       </sect2>
 127       <sect2>
 128         <title>+j, join throttling</title>
 129         <para>
 130           This mode takes one parameter of the form <replaceable>n</replaceable>:<replaceable>t</replaceable>, where <replaceable>n</replaceable> and <replaceable>t</replaceable> are positive integers. Only <replaceable>n</replaceable> users may join in each period of <replaceable>t</replaceable> seconds.
 131         </para>
 132         <para>
 133           Due to propagation delays between servers, more users may be
 134           able to join (by racing for the last slot on each server).
 135         </para>
 136       </sect2>
 137       <sect2>
 138         <title>+k, key (channel password)</title>
 139         <para>
 140           Taking one parameter, when set, this mode requires a user to supply the key in order to join
 141           the channel: /JOIN #channel key.
 142         </para>
 143       </sect2>
 144       <sect2>
 145         <title>+l, channel member limit</title>
 146         <para>
 147           Takes one numeric parameter, the number of users which are allowed to be in the channel before
 148           further joins are blocked.
 149         </para>
 150         <para>
 151           Due to propagation delays between servers, more users may be
 152           able to join (by racing for the last slot on each server).
 153         </para>
 154       </sect2>
 155       <sect2>
 156         <title>+L, large ban list</title>
 157         <para>
 158           Channels with this mode will be allowed larger banlists (by default,
 159           500 instead of 50 entries for +b, +q, +e and +I together).
 160           Only network operators may set this mode.
 161         </para>
 162       </sect2>
 163       <sect2>
 164         <title>+m, moderated</title>
 165         <para>
 166           When a channel is set +m, only users with +o or +v on the channel can send to it.
 167         </para>
 168         <para>
 169           Users can still knock on the channel or change their nick.
 170         </para>
 171       </sect2>
 172       <sect2>
 173         <title>+n, no external messages</title>
 174         <para>
 175           When set, this mode prevents users from sending to the channel without being in it themselves.
 176           This is recommended.
 177         </para>
 178       </sect2>
 179       <sect2>
 180         <title>+o, channel operator</title>
 181         <para>
 182           This mode takes one parameter, a nick, and grants or removes channel
 183           operator privilege to that user. Channel operators have full control
 184           over the channel, having the ability to set all channel modes except
 185           +L and +P, and kick users.
 186           Like voiced users, channel operators can always
 187           send to the channel, overriding +b, +m and +q modes and the
 188           per-channel flood limit.
 189           In most clients channel operators are marked with an '@' sign.
 190         </para>
 191         <para>
 192           The privilege is lost if the user leaves the channel or server
 193           in any way.
 194         </para>
 195         <para>
 196           Most networks will run channel registration services (e.g. ChanServ)
 197           which ensure the founder (and users designated by the founder) can
 198           always gain channel operator privileges and provide some features
 199           to manage the channel.
 200         </para>
 201       </sect2>
 202       <sect2>
 203         <title>+p, paranoid channel</title>
 204         <para>
 205           When set, the KNOCK command cannot be used on the channel
 206           to request an invite, and users will not be shown the
 207           channel in WHOIS replies unless they are on it.
 208           Unlike in traditional IRC, +p and +s can be set together.
 209         </para>
 210       </sect2>
 211       <sect2>
 212         <title>+P, permanent channel</title>
 213         <para>
 214           Channels with this mode (which is accessible only to network operators) set will not be destroyed
 215           when the last user leaves.
 216         </para>
 217         <para>
 218           This makes it less likely modes, bans and the topic will be lost and
 219           makes it harder to abuse network splits, but also causes more
 220           unwanted restoring of old modes, bans and topics after long splits.
 221         </para>
 222       </sect2>
 223       <sect2>
 224         <title>+q, quiet</title>
 225         <para>
 226           This mode behaves exactly like +b (ban), except that the user may still join
 227           the channel. The net effect is that they cannot knock on the channel,
 228           send to the channel or change their nick while on channel.
 229         </para>
 230       </sect2>
 231       <sect2>
 232         <title>+Q, block forwarded users</title>
 233         <para>
 234           Channels with this mode set are not valid targets for forwarding. Any attempt to forward to
 235           this channel will be ignored, and the user will be handled as if the attempt was never made (by
 236           sending them the relevant error message).
 237         </para>
 238         <para>
 239           This does not affect the ability to set +f.
 240         </para>
 241       </sect2>
 242       <sect2>
 243         <title>+r, block unidentified</title>
 244         <para>
 245           When set, this mode prevents unidentified users from joining.
 246         </para>
 247       </sect2>
 248       <!-- not planned (jilles)
 249       <sect2>
 250         <title>+R, quiet unidentified</title>
 251         <para>
 252           When set, this mode prevents unidentified users from sending to the channel, although they can
 253           still join.
 254         </para>
 255         <para>
 256           Please note that this mode is not implemented in Charybdis 1.0.x, and is documented in
 257           expectation for upcoming Charybdis 1.1.
 258         </para>
 259       </sect2>
 260       -->
 261       <sect2>
 262         <title>+s, secret channel</title>
 263         <para>
 264           When set, this mode prevents the channel from appearing in the
 265           output of the LIST, WHO and WHOIS command by users who are not on
 266           it. Also, the server will refuse to answer WHO, NAMES, TOPIC and
 267           LIST queries from users not on the channel.
 268         </para>
 269       </sect2>
 270       <sect2>
 271         <title>+t, topic limit</title>
 272         <para>
 273           When set, this mode prevents users who are not channel operators
 274           from changing the topic.
 275         </para>
 276       </sect2>
 277       <sect2>
 278         <title>+v, voice</title>
 279         <para>
 280           This mode takes one parameter, a nick, and grants or removes voice
 281           privilege to that user. Voiced users can always send to the channel,
 282           overriding +b, +m and +q modes and the per-channel flood limit.
 283           In most clients voiced users are marked with a plus sign.
 284         </para>
 285         <para>
 286           The privilege is lost if the user leaves the channel or server
 287           in any way.
 288         </para>
 289       </sect2>
 290       <sect2>
 291         <title>+z, reduced moderation</title>
 292         <para>
 293           When +z is set, the effects of +m are relaxed. For each message, if that message
 294           would normally be blocked by moderation, it is instead sent to all channel operators. This is intended for use in moderated debates.
 295         </para>
 296         <para>
 297           Note that +n and channel bans/quiets are unaffected by this. To silence a given user completely,
 298           remove them from the channel.
 299         </para>
 300       </sect2>
 301     </sect1>
 302   </chapter>
 303 <!-- Keep this comment at the end of the file
 304 Local variables:
 305 mode: sgml
 306 sgml-omittag:t
 307 sgml-shorttag:t
 308 sgml-namecase-general:t
 309 sgml-general-insert-case:lower
 310 sgml-minimize-attributes:nil
 311 sgml-always-quote-attributes:t
 312 sgml-indent-step:2
 313 sgml-indent-data:t
 314 sgml-parent-document:("charybdis-oper-guide.sgml" "book")
 315 sgml-exposed-tags:nil
 316 fill-column:105
 317 End:
 318 -->