[irc/rqf/shadowircd.git] / doc / sgml / oper-guide / cmodes.sgml

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