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

  <chapter id="umodes">
    <title>Umodes</title>
    <sect1 id="umodelist">
      <title>Meanings of user modes</title>
      <sect2>
	<title>+a, server administrator</title>
	<para>
	  This vanity usermode is used to denote a server administrator in WHOIS output.
	  All local <quote>admin</quote> privileges are independent of it, though services
	  packages may grant extra privileges to +a users.
	</para>
      </sect2>
      <sect2>
	<title>+D, deaf</title>
	<para>
	  <note>
	    <para>
	      This is a user umode, which anybody can set. It is not specific to operators.
	    </para>
	  </note>
	  Users with the +D umode set will not receive messages sent to
	  channels. Joins, parts, topic changes, mode changes, etc are
	  received as normal, as are private messages.
	</para>
	<para>
	  Support of this umode is indicated by the DEAF token in
	  RPL_ISUPPORT (005); the parameter indicates the letter
	  of the umode. Note that several common IRCD implementations have
	  an umode like this (typically +d) but do not have the token in 005.
	</para>
      </sect2>
      <sect2>
	<title>+g, Caller ID</title>
	<para>
	  <note>
	    <para>
	      This is a user umode, which anybody can set. It is not specific to operators.
	    </para>
	  </note>
	  Users with the +g umode set will only receive private messages from users on a
	  session-defined whitelist, defined by the /accept command. If a user who is not
	  on the whitelist attempts to send a private message, the target user will receive a rate-limited notice saying that the user
	  wishes to speak to them.
	</para>
	<para>
	  Network operators are not affected by the callerid whitelist system in the event
	  that they need to speak to users who have it enabled.
	</para>
	<para>
	  Support of this umode is indicated by the CALLERID token in
	  RPL_ISUPPORT (005); the optional parameter indicates the letter
	  of the umode, otherwise +g.
	</para>
      </sect2>
      <sect2>
	<title>+i, invisible</title>
	<para>
	  <note>
	    <para>
	      This is a user umode, which anybody can set. It is not specific to operators.
	    </para>
	  </note>
	  Invisible users do not show up in WHO and NAMES unless you can see them.
	</para>
      </sect2>
      <!-- not planned (jilles)
      <sect2>
	<title>+I, refuse invite</title>
	<para>
	  <note>
	    <para>
	      This is a user umode, which anybody can set. It is not specific to operators.
	    </para>
	  </note>
	  If you have the +I umode set, nobody will be able to issue an INVITE to let you
	  in to a channel.
	</para>
	<para>
	  This mode is not yet implemented. It will be implemented in Charybdis 1.1.
	</para>
      </sect2>
      -->
      <sect2>
	<title>+l, receive locops</title>
	<para>
	  LOCOPS is a version of OPERWALL that is sent to opers on a single
	  server only. With cluster{} and shared{} blocks they can optionally
	  be propagated further.
	</para>
	<para>
	  Unlike OPERWALL, any oper can send and receive LOCOPS.
	</para>
      </sect2>
      <sect2>
	<title>+o, operator</title>
	<para>
	  This indicates global operator status.
	</para>
      </sect2>
      <sect2>
	<title>+Q, disable forwarding</title>
	<para>
	  <note>
	    <para>
	      This is a user umode, which anybody can set. It is not specific to operators.
	    </para>
	  </note>
          This umode prevents you from being affected by any of the channel forwarding mechanisms. In
          any event where you would normally be forwarded, instead you will get the usual error message
          as if no forwarding was in effect.
	</para>
      </sect2>
      <sect2>
	<title>+R, reject messages from unauthenticated users</title>
	<para>
	  <note>
	    <para>
	      This is a user umode, which anybody can set. It is not specific to operators.
	    </para>
	  </note>
	  If a user has the +R umode set, then any users who are not authenticated
	  will receive an error message if they attempt to send a private
	  message or notice to the +R user.
	</para>
	<para>
	  Opers and accepted users (like in +g) are exempt.
	  Unlike +g, the target user is not notified of failed messages.
	</para>
      </sect2>
      <sect2>
	<title>+s, receive server notices</title>
	<para>
	  This umode allows an oper to receive server notices.
	  The requested types of server notices are specified as a
	  parameter (<quote>snomask</quote>) to this umode.
	</para>
      </sect2>
      <sect2>
	<title>+S, network service</title>
	<para>
	  <note>
	    <para>
	      This umode can only be set by servers named in a service{}
	      block.
	    </para>
	  </note>
	  This umode grants various features useful for services. For example,
	  clients with this umode cannot be kicked or deopped on channels,
	  do not show channels the querying user is not on in WHOIS,
	  and do not appear in /stats p.
	</para>
	<para>
	  The exact effects of this umode are variable; no user or oper on
	  an actual charybdis server can set it.
	</para>
      </sect2>
      <sect2>
	<title>+w, receive wallops</title>
	<para>
	  <note>
	    <para>
	      This is a user umode, which anybody can set. It is not specific to operators.
	    </para>
	  </note>
	  Users with the +w umode set will receive WALLOPS messages sent by opers.
	  Opers with +w additionally receive WALLOPS sent by servers (e.g.
	  remote CONNECT, remote SQUIT, many services packages).
	</para>
      </sect2>
      <sect2>
	<title>+z, receive operwall</title>
	<para>
	  OPERWALL differs from WALLOPS in that the ability to receive such messages is
	  restricted. Opers with +z set will receive OPERWALL messages.
	</para>
      </sect2>
    </sect1>
    <sect1 id="snomaskusage">
      <title>Snomask usage</title>
      <para>
	Usage is as follows:
      </para>
      <cmdsynopsis><command>MODE</command> 
	<arg choice=plain><replaceable>nick</replaceable></arg> 
	<arg choice=plain>+s</arg>
	<arg choice=plain><replaceable>+/-flags</replaceable></arg>
      </cmdsynopsis>
      <para>
	To set snomasks.
      </para>
      <cmdsynopsis><command>MODE</command> 
	<arg choice=plain><replaceable>nick</replaceable></arg> 
	<arg choice=plain>-s</arg>
      </cmdsynopsis>
      <para>
	To clear all snomasks.
      </para>
      <para>
	Umode +s will be set if at least one snomask is set.
      </para>
      <para>
	Umode +s is oper only by default, but even if you allow nonopers to
	set it, they will not get any server notices.
      </para>
    </sect1>
    <sect1 id="snomasklist">
      <title>Meanings of server notice masks</title>
      <sect2>
	<title>+b, bot warnings</title>
	<para>
	  Opers with the +b snomask set will receive warning messages from the server when potential
	  flooders and spambots are detected.
	</para>
      </sect2>
      <sect2>
	<title>+c, client connections</title>
	<para>
	  Opers who have the +c snomask set will receive server notices when clients attach to the
	  local server.
	</para>
      </sect2>
      <sect2>
	<title>+C, extended client connection notices</title>
	<para>
	  Opers who have the +C snomask set will receive server notices when clients attach to the
	  local server. Unlike the +c snomask, the information is displayed in a format intended
	  to be parsed by scripts, and includes the two unused fields of the USER command.
	</para>
      </sect2>
      <sect2>
	<title>+d, debug</title>
	<para>
	  The +d snomask provides opers extra information which may be of interest to debuggers.
	  It will also cause the user to receive server notices if certain assertions fail inside the
	  server. Its precise meaning is variable. Do not depend on the
	  effects of this snomask as they can and will change without notice in later revisions.
	</para>
      </sect2>
      <sect2>
	<title>+f, full warning</title>
	<para>
	  Opers with the +f snomask set will receive notices when a user
	  connection is denied because a connection limit is exceeded
	  (one of the limits in a class{} block, or the total per-server
	  limit settable with /quote set max).
	</para>
      </sect2>
      <sect2>
	<title>+k, server kill notices</title>
	<para>
	  Opers with the +k snomask set will receive server notices when
	  services kill users and when
	  other servers kill and save (forced nick change to UID) users.
	  Kills and saves by this server are on +d or +s.
	</para>
      </sect2>
      <sect2>
	<title>+n, nick change notices</title>
	<para>
	  An oper with +n set will receive a server notice every time a local user changes their nick,
	  giving the old and new nicks.
	  This is mostly useful for bots that track all users on a single server.
	</para>
      </sect2>
      <sect2>
	<title>+r, notices on name rejections</title>
	<para>
	  Opers with this snomask set will receive a server notice when somebody tries to use an
	  invalid username, or if a dumb HTTP proxy tries to connect.
	</para>
      </sect2>
      <sect2>
	<title>+s, generic server notices</title>
	<para>
	  This snomask allows an oper to receive generic server notices.
	  This includes kills from opers (except services).
	</para>
      </sect2>
      <sect2>
	<title>+u, unauthorized connections</title>
	<para>
	  This snomask allows an oper to see when users try to connect who do not have an
	  available auth{} block.
	</para>
      </sect2>
      <sect2>
	<title>+x, extra routing notices</title>
	<para>
	  Opers who have the +x snomask set will get notices about servers
	  connecting and disconnecting on the whole network. This includes
	  all servers connected behind the affected link. This can get
	  rather noisy but is useful for keeping track of all linked
	  servers.
	</para>
      </sect2>
      <sect2>
	<title>+y, spy</title>
	<para>
	  Opers with +y receive notices when users try to join RESV'ed (<quote>juped</quote>) channels. 
	  Additionally, if certain extension modules are loaded, they will
	  receive notices when special commands are used and/or when they
	  are whoised.
	</para>
      </sect2>
      <sect2>
	<title>+Z, operspy notices</title>
	<para>
	  Opers with +Z receive notices whenever an oper anywhere on the
	  network uses operspy.
	</para>
	<para>
	  This snomask can be configured to be only effective for admins.
	</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
sgml-validate-command: "nsgmls -e -g -s -u charybdis-oper-guide.sgml"
End:
-->
Commit	Line	Data
212380e3	1	<chapter id="umodes">
	2	<title>Umodes</title>
	3	<sect1 id="umodelist">
	4	<title>Meanings of user modes</title>
	5	<sect2>
	6	<title>+a, server administrator</title>
	7	<para>
	8	This vanity usermode is used to denote a server administrator in WHOIS output.
	9	All local <quote>admin</quote> privileges are independent of it, though services
	10	packages may grant extra privileges to +a users.
	11	</para>
	12	</sect2>
	13	<sect2>
	14	<title>+D, deaf</title>
	15	<para>
	16	<note>
	17	<para>
	18	This is a user umode, which anybody can set. It is not specific to operators.
	19	</para>
	20	</note>
	21	Users with the +D umode set will not receive messages sent to
	22	channels. Joins, parts, topic changes, mode changes, etc are
	23	received as normal, as are private messages.
	24	</para>
	25	<para>
	26	Support of this umode is indicated by the DEAF token in
	27	RPL_ISUPPORT (005); the parameter indicates the letter
	28	of the umode. Note that several common IRCD implementations have
	29	an umode like this (typically +d) but do not have the token in 005.
	30	</para>
	31	</sect2>
	32	<sect2>
	33	<title>+g, Caller ID</title>
	34	<para>
	35	<note>
	36	<para>
	37	This is a user umode, which anybody can set. It is not specific to operators.
	38	</para>
	39	</note>
	40	Users with the +g umode set will only receive private messages from users on a
	41	session-defined whitelist, defined by the /accept command. If a user who is not
	42	on the whitelist attempts to send a private message, the target user will receive a rate-limited notice saying that the user
	43	wishes to speak to them.
	44	</para>
	45	<para>
	46	Network operators are not affected by the callerid whitelist system in the event
	47	that they need to speak to users who have it enabled.
	48	</para>
	49	<para>
	50	Support of this umode is indicated by the CALLERID token in
	51	RPL_ISUPPORT (005); the optional parameter indicates the letter
	52	of the umode, otherwise +g.
	53	</para>
	54	</sect2>
	55	<sect2>
	56	<title>+i, invisible</title>
	57	<para>
	58	<note>
	59	<para>
	60	This is a user umode, which anybody can set. It is not specific to operators.
	61	</para>
	62	</note>
	63	Invisible users do not show up in WHO and NAMES unless you can see them.
	64	</para>
65	</sect2>
66	<!-- not planned (jilles)
67	<sect2>
68	<title>+I, refuse invite</title>
69	<para>
70	<note>
71	<para>
72	This is a user umode, which anybody can set. It is not specific to operators.
73	</para>
74	</note>
75	If you have the +I umode set, nobody will be able to issue an INVITE to let you
76	in to a channel.
77	</para>
78	<para>
79	This mode is not yet implemented. It will be implemented in Charybdis 1.1.
80	</para>
81	</sect2>
82	-->
83	<sect2>
84	<title>+l, receive locops</title>
85	<para>
86	LOCOPS is a version of OPERWALL that is sent to opers on a single
87	server only. With cluster{} and shared{} blocks they can optionally
88	be propagated further.
89	</para>
90	<para>
91	Unlike OPERWALL, any oper can send and receive LOCOPS.
92	</para>
93	</sect2>
94	<sect2>
95	<title>+o, operator</title>
96	<para>
97	This indicates global operator status.
98	</para>
99	</sect2>
100	<sect2>
101	<title>+Q, disable forwarding</title>
102	<para>
103	<note>
104	<para>
105	This is a user umode, which anybody can set. It is not specific to operators.
106	</para>
107	</note>
108	This umode prevents you from being affected by any of the channel forwarding mechanisms. In
109	any event where you would normally be forwarded, instead you will get the usual error message
110	as if no forwarding was in effect.
111	</para>
112	</sect2>
113	<sect2>
114	<title>+R, reject messages from unauthenticated users</title>
115	<para>
116	<note>
117	<para>
118	This is a user umode, which anybody can set. It is not specific to operators.
119	</para>
120	</note>
121	If a user has the +R umode set, then any users who are not authenticated
122	will receive an error message if they attempt to send a private
123	message or notice to the +R user.
124	</para>
125	<para>
126	Opers and accepted users (like in +g) are exempt.
127	Unlike +g, the target user is not notified of failed messages.
128	</para>
129	</sect2>
130	<sect2>
131	<title>+s, receive server notices</title>
132	<para>
133	This umode allows an oper to receive server notices.
134	The requested types of server notices are specified as a
135	parameter (<quote>snomask</quote>) to this umode.
136	</para>
137	</sect2>
138	<sect2>
139	<title>+S, network service</title>
140	<para>
141	<note>
142	<para>
143	This umode can only be set by servers named in a service{}
144	block.
145	</para>
146	</note>
147	This umode grants various features useful for services. For example,
148	clients with this umode cannot be kicked or deopped on channels,
149	do not show channels the querying user is not on in WHOIS,
150	and do not appear in /stats p.
151	</para>
152	<para>
153	The exact effects of this umode are variable; no user or oper on
154	an actual charybdis server can set it.
155	</para>
156	</sect2>
157	<sect2>
158	<title>+w, receive wallops</title>
159	<para>
160	<note>
161	<para>
162	This is a user umode, which anybody can set. It is not specific to operators.
163	</para>
164	</note>
165	Users with the +w umode set will receive WALLOPS messages sent by opers.
166	Opers with +w additionally receive WALLOPS sent by servers (e.g.
167	remote CONNECT, remote SQUIT, many services packages).
168	</para>
169	</sect2>
170	<sect2>
171	<title>+z, receive operwall</title>
172	<para>
173	OPERWALL differs from WALLOPS in that the ability to receive such messages is
174	restricted. Opers with +z set will receive OPERWALL messages.
175	</para>
176	</sect2>
177	</sect1>
178	<sect1 id="snomaskusage">
179	<title>Snomask usage</title>
180	<para>
181	Usage is as follows:
182	</para>
183	<cmdsynopsis><command>MODE</command>
184	<arg choice=plain><replaceable>nick</replaceable></arg>
185	<arg choice=plain>+s</arg>
186	<arg choice=plain><replaceable>+/-flags</replaceable></arg>
187	</cmdsynopsis>
188	<para>
189	To set snomasks.
190	</para>
191	<cmdsynopsis><command>MODE</command>
192	<arg choice=plain><replaceable>nick</replaceable></arg>
193	<arg choice=plain>-s</arg>
194	</cmdsynopsis>
195	<para>
196	To clear all snomasks.
197	</para>
198	<para>
199	Umode +s will be set if at least one snomask is set.
200	</para>
201	<para>
202	Umode +s is oper only by default, but even if you allow nonopers to
203	set it, they will not get any server notices.
204	</para>
205	</sect1>
206	<sect1 id="snomasklist">
207	<title>Meanings of server notice masks</title>
208	<sect2>
209	<title>+b, bot warnings</title>
210	<para>
211	Opers with the +b snomask set will receive warning messages from the server when potential
212	flooders and spambots are detected.
213	</para>
214	</sect2>
215	<sect2>
216	<title>+c, client connections</title>
217	<para>
218	Opers who have the +c snomask set will receive server notices when clients attach to the
219	local server.
220	</para>
221	</sect2>
222	<sect2>
223	<title>+C, extended client connection notices</title>
224	<para>
225	Opers who have the +C snomask set will receive server notices when clients attach to the
226	local server. Unlike the +c snomask, the information is displayed in a format intended
227	to be parsed by scripts, and includes the two unused fields of the USER command.
228	</para>
229	</sect2>
230	<sect2>
231	<title>+d, debug</title>
232	<para>
233	The +d snomask provides opers extra information which may be of interest to debuggers.
234	It will also cause the user to receive server notices if certain assertions fail inside the
235	server. Its precise meaning is variable. Do not depend on the
236	effects of this snomask as they can and will change without notice in later revisions.
237	</para>
238	</sect2>
239	<sect2>
240	<title>+f, full warning</title>
241	<para>
242	Opers with the +f snomask set will receive notices when a user
243	connection is denied because a connection limit is exceeded
244	(one of the limits in a class{} block, or the total per-server
245	limit settable with /quote set max).
246	</para>
247	</sect2>
248	<sect2>
249	<title>+k, server kill notices</title>
250	<para>
251	Opers with the +k snomask set will receive server notices when
252	services kill users and when
253	other servers kill and save (forced nick change to UID) users.
254	Kills and saves by this server are on +d or +s.
255	</para>
256	</sect2>
257	<sect2>
258	<title>+n, nick change notices</title>
259	<para>
260	An oper with +n set will receive a server notice every time a local user changes their nick,
261	giving the old and new nicks.
262	This is mostly useful for bots that track all users on a single server.
263	</para>
264	</sect2>
265	<sect2>
266	<title>+r, notices on name rejections</title>
267	<para>
268	Opers with this snomask set will receive a server notice when somebody tries to use an
269	invalid username, or if a dumb HTTP proxy tries to connect.
270	</para>
271	</sect2>
272	<sect2>
273	<title>+s, generic server notices</title>
274	<para>
275	This snomask allows an oper to receive generic server notices.
276	This includes kills from opers (except services).
277	</para>
278	</sect2>
279	<sect2>
280	<title>+u, unauthorized connections</title>
281	<para>
282	This snomask allows an oper to see when users try to connect who do not have an
283	available auth{} block.
284	</para>
285	</sect2>
286	<sect2>
287	<title>+x, extra routing notices</title>
288	<para>
289	Opers who have the +x snomask set will get notices about servers
290	connecting and disconnecting on the whole network. This includes
291	all servers connected behind the affected link. This can get
292	rather noisy but is useful for keeping track of all linked
293	servers.
294	</para>
295	</sect2>
296	<sect2>
297	<title>+y, spy</title>
298	<para>
299	Opers with +y receive notices when users try to join RESV'ed (<quote>juped</quote>) channels.
300	Additionally, if certain extension modules are loaded, they will
301	receive notices when special commands are used and/or when they
302	are whoised.
303	</para>
304	</sect2>
305	<sect2>
306	<title>+Z, operspy notices</title>
307	<para>
308	Opers with +Z receive notices whenever an oper anywhere on the
309	network uses operspy.
310	</para>
311	<para>
312	This snomask can be configured to be only effective for admins.
313	</para>
314	</sect2>
315	</sect1>
316	</chapter>
317	<!-- Keep this comment at the end of the file
318	Local variables:
319	mode: sgml
320	sgml-omittag:t
321	sgml-shorttag:t
322	sgml-namecase-general:t
323	sgml-general-insert-case:lower
324	sgml-minimize-attributes:nil
325	sgml-always-quote-attributes:t
326	sgml-indent-step:2
327	sgml-indent-data:t
328	sgml-parent-document: ("charybdis-oper-guide.sgml" "book")
329	sgml-exposed-tags:nil
330	fill-column: 105
331	sgml-validate-command: "nsgmls -e -g -s -u charybdis-oper-guide.sgml"
332	End:
333	-->