9pfs/solanum-vs-hackint-and-charybdis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

some styling

Browse source 
turn all +flags into preformatted flags, fix admonitions
This commit is contained in:
Antoine Beaupré 2017-03-25 11:33:06 -04:00
parent bc9cb138a4
commit bdfadfcb99
No known key found for this signature in database
GPG key ID: 792152527B75921E
6 changed files with 221 additions and 255 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

161
doc/oper-guide/cmodes.rst
View file

@ -1,15 +1,15 @@
Channel modes Channel modes
============= =============
+b, channel ban ``+b``, channel ban
--------------- -------------------
Bans take one parameter which can take several forms. The most common Bans take one parameter which can take several forms. The most common
form is +b nick!user@host. The wildcards \* and ? are allowed, matching form is ``+b nick!user@host``. The wildcards ``*`` and ``?`` are allowed, matching
zero-or-more, and exactly-one characters respectively. The masks will be zero-or-more, and exactly-one characters respectively. The masks will be
trimmed to fit the maximum allowable length for the relevant element. 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 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 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 with IPv6. Bans are not checked against the real hostname behind any
kind of spoof, except if host mangling is in use (e.g. kind of spoof, except if host mangling is in use (e.g.
``extensions/ip_cloaking.so``): if the user's host is mangled, their ``extensions/ip_cloaking.so``): if the user's host is mangled, their
@ -18,11 +18,11 @@ could enable mangling, the mangled form of their hostname is checked
additionally. Hence, it is not possible to evade bans by toggling host additionally. Hence, it is not possible to evade bans by toggling host
mangling. mangling.
The second form (extban) is +b $type or +b $type:data. type is a single The second form (extban) is ``+b $type`` or ``+b $type:data``. type is a single
character (case insensitive) indicating the type of match, optionally character (case insensitive) indicating the type of match, optionally
preceded by a tilde (~) to negate the comparison. data depends on type. 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 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 in the EXTBAN token of the 005 (``RPL_ISUPPORT``) numeric. See
``doc/extban.txt`` in the source distribution for more information. ``doc/extban.txt`` in the source distribution for more information.
If no parameter is given, the list of bans is returned. All users can If no parameter is given, the list of bans is returned. All users can
@ -32,98 +32,97 @@ 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 If they are already on the channel, they may not send to it or change
their nick. their nick.
+c, colour filter ``+c``, colour filter
----------------- ---------------------
This cmode activates the colour filter for the channel. This filters out This cmode activates the colour filter for the channel. This filters out
bold, underline, reverse video, beeps, mIRC colour codes, and ANSI bold, underline, reverse video, beeps, mIRC colour codes, and ANSI
escapes. Note that escape sequences will usually leave cruft sent to the escapes. Note that escape sequences will usually leave cruft sent to the
channel, just without the escape characters themselves. channel, just without the escape characters themselves.
+e, ban exemption ``+e``, ban exemption
----------------- ---------------------
This mode takes one parameter of the same form as bans, which overrides This mode takes one parameter of the same form as bans, which overrides
+b and +q bans for all clients it matches. ``+b`` and ``+q`` bans for all clients it matches.
This can be useful if it is necessary to ban an entire ISP due to This can be useful if it is necessary to ban an entire ISP due to
persistent abuse, but some users from that ISP should still be allowed persistent abuse, but some users from that ISP should still be allowed
in. For example: /mode #channel +be \*!\*@\*.example.com in. For example: ``/mode #channel +be *!*@*.example.com *!*someuser@host3.example.com``
\*!\*someuser@host3.example.com
Only channel operators can see +e changes or request the list. Only channel operators can see ``+e`` changes or request the list.
+f, channel forwarding ``+f``, channel forwarding
---------------------- --------------------------
This mode takes one parameter, the name of a channel (+f #channel). If 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 the channel also has the ``+i`` cmode set, and somebody attempts to join
without either being expliticly invited, or having an invex (+I), then without either being expliticly invited, or having an invex (``+I``), then
they will instead join the channel named in the mode parameter. The 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 client will also be sent a 470 numeric giving the original and target
channels. channels.
Users are similarly forwarded if the +j cmode is set and their attempt 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 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. in the channel or if ``+r`` is set and they are not identified.
Forwards may only be set to +F channels, or to channels the setter has Forwards may only be set to ``+F`` channels, or to channels the setter has
ops in. ops in.
Without parameter (/mode #channel f or /mode #channel +f) the forward Without parameter (``/mode #channel f`` or ``/mode #channel +f``) the forward
channel is returned. This form also works off channel. channel is returned. This form also works off channel.
+F, allow anybody to forward to this ``+F``, allow anybody to forward to this
------------------------------------ ----------------------------------------
When this mode is set, anybody may set a forward from a channel they 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 have ops in to this channel. Otherwise they have to have ops in this
channel. channel.
+g, allow anybody to invite ``+g``, allow anybody to invite
--------------------------- -------------------------------
When this mode is set, anybody may use the INVITE command on the channel 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 in question. When it is unset, only channel operators may use the INVITE
command. command.
When this mode is set together with +i, +j, +l or +r, all channel When this mode is set together with ``+i``, ``+j``, ``+l`` or ``+r``, all channel
members can influence who can join. members can influence who can join.
+i, invite only ``+i``, invite only
--------------- -------------------
When this cmode is set, no client can join the channel unless they have When this cmode is set, no client can join the channel unless they have
an invex (+I) or are invited with the INVITE command. an invex (``+I``) or are invited with the INVITE command.
+I, invite exception (invex) ``+I``, invite exception (invex)
---------------------------- --------------------------------
This mode takes one parameter of the same form as bans. Matching clients 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 do not need to be invited to join the channel when it is invite-only
(+i). Unlike the INVITE command, this does not override +j, +l and +r. (``+i``). Unlike the INVITE command, this does not override ``+j``, ``+l`` and ``+r``.
Only channel operators can see +I changes or request the list. Only channel operators can see ``+I`` changes or request the list.
+j, join throttling ``+j``, join throttling
------------------- -----------------------
This mode takes one parameter of the form n:t, where n and t are This mode takes one parameter of the form n:t, where n and t are
positive integers. Only n users may join in each period of t seconds. positive integers. Only n users may join in each period of t seconds.
Invited users can join regardless of +j, but are counted as normal. Invited users can join regardless of ``+j``, but are counted as normal.
Due to propagation delays between servers, more users may be able to Due to propagation delays between servers, more users may be able to
join (by racing for the last slot on each server). join (by racing for the last slot on each server).
+k, key (channel password) ``+k``, key (channel password)
-------------------------- ------------------------------
Taking one parameter, when set, this mode requires a user to supply the Taking one parameter, when set, this mode requires a user to supply the
key in order to join the channel: /JOIN #channel key. key in order to join the channel: /JOIN #channel key.
+l, channel member limit ``+l``, channel member limit
------------------------ ----------------------------
Takes one numeric parameter, the number of users which are allowed to be Takes one numeric parameter, the number of users which are allowed to be
in the channel before further joins are blocked. Invited users may join in the channel before further joins are blocked. Invited users may join
@ -132,35 +131,35 @@ regardless.
Due to propagation delays between servers, more users may be able to Due to propagation delays between servers, more users may be able to
join (by racing for the last slot on each server). join (by racing for the last slot on each server).
+L, large ban list ``+L``, large ban list
------------------ ----------------------
Channels with this mode will be allowed larger banlists (by default, 500 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 instead of 50 entries for ``+b``, ``+q``, ``+e`` and ``+I`` together). Only network
operators with resv privilege may set this mode. operators with resv privilege may set this mode.
+m, moderated ``+m``, moderated
------------- -----------------
When a channel is set +m, only users with +o or +v on the channel can When a channel is set ``+m``, only users with ``+o`` or ``+v`` on the channel can
send to it. send to it.
Users can still knock on the channel or change their nick. Users can still knock on the channel or change their nick.
+n, no external messages ``+n``, no external messages
------------------------ ----------------------------
When set, this mode prevents users from sending to the channel without When set, this mode prevents users from sending to the channel without
being in it themselves. This is recommended. being in it themselves. This is recommended.
+o, channel operator ``+o``, channel operator
-------------------- ------------------------
This mode takes one parameter, a nick, and grants or removes channel This mode takes one parameter, a nick, and grants or removes channel
operator privilege to that user. Channel operators have full control operator privilege to that user. Channel operators have full control
over the channel, having the ability to set all channel modes except +L 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 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 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 '@' flood limit. In most clients channel operators are marked with an '@'
sign. sign.
@ -172,16 +171,16 @@ which ensure the founder (and users designated by the founder) can
always gain channel operator privileges and provide some features to always gain channel operator privileges and provide some features to
manage the channel. manage the channel.
+p, paranoid channel ``+p``, paranoid channel
-------------------- ------------------------
When set, the KNOCK command cannot be used on the channel to request an 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 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 they are on it. Unlike in traditional IRC, ``+p`` and ``+s`` can be set
together. together.
+P, permanent channel ``+P``, permanent channel
--------------------- -------------------------
Channels with this mode (which is accessible only to network operators Channels with this mode (which is accessible only to network operators
with resv privilege) set will not be destroyed when the last user with resv privilege) set will not be destroyed when the last user
@ -191,61 +190,61 @@ 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 makes it harder to abuse network splits, but also causes more unwanted
restoring of old modes, bans and topics after long splits. restoring of old modes, bans and topics after long splits.
+q, quiet ``+q``, quiet
--------- -------------
This mode behaves exactly like +b (ban), except that the user may still 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 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. channel, send to the channel or change their nick while on channel.
+Q, block forwarded users ``+Q``, block forwarded users
------------------------- -----------------------------
Channels with this mode set are not valid targets for forwarding. Any 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 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 handled as if the attempt was never made (by sending them the relevant
error message). error message).
This does not affect the ability to set +f. This does not affect the ability to set ``+f``.
+r, block unidentified ``+r``, block unidentified
---------------------- --------------------------
When set, this mode prevents unidentified users from joining. Invited When set, this mode prevents unidentified users from joining. Invited
users can still join. users can still join.
+s, secret channel ``+s``, secret channel
------------------ ----------------------
When set, this mode prevents the channel from appearing in the output of 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 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 server will refuse to answer WHO, NAMES, TOPIC and LIST queries from
users not on the channel. users not on the channel.
+t, topic limit ``+t``, topic limit
--------------- -------------------
When set, this mode prevents users who are not channel operators from When set, this mode prevents users who are not channel operators from
changing the topic. changing the topic.
+v, voice ``+v``, voice
--------- -------------
This mode takes one parameter, a nick, and grants or removes voice This mode takes one parameter, a nick, and grants or removes voice
privilege to that user. Voiced users can always send to the channel, 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 overriding ``+b``, ``+m`` and ``+q`` modes and the per-channel flood limit. In most
clients voiced users are marked with a plus sign. clients voiced users are marked with a plus sign.
The privilege is lost if the user leaves the channel or server in any The privilege is lost if the user leaves the channel or server in any
way. way.
+z, reduced moderation ``+z``, reduced moderation
---------------------- --------------------------
When +z is set, the effects of +m, +b and +q are relaxed. For each When ``+z`` is set, the effects of ``+m``, ``+b`` and ``+q`` are relaxed. For each
message, if that message would normally be blocked by one of these message, if that message would normally be blocked by one of these
modes, it is instead sent to all channel operators. This is intended for modes, it is instead sent to all channel operators. This is intended for
use in moderated debates. use in moderated debates.
Note that +n is unaffected by this. To silence a given user completely, Note that ``+n`` is unaffected by this. To silence a given user completely,
remove them from the channel. remove them from the channel.

22
doc/oper-guide/commands.rst
View file

@ -4,11 +4,9 @@ Operator Commands
Network management commands Network management commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note** .. note:: All commands and names are case insensitive. Parameters
consisting of one or more separate letters, such as in MODE,
All commands and names are case insensitive. Parameters consisting STATS and WHO, are case sensitive.
of one or more separate letters, such as in MODE, STATS and WHO, are
case sensitive.
CONNECT CONNECT
------- -------
@ -95,10 +93,8 @@ scratch as if it had just been executed.
This reexecutes the ircd using the compiled-in path, visible as SPATH in This reexecutes the ircd using the compiled-in path, visible as SPATH in
INFO. INFO.
**Note** .. note:: This command cannot be used remotely. The server name is
used only as a safety measure.
This command cannot be used remotely. The server name is used only
as a safety measure.
DIE DIE
--- ---
@ -108,10 +104,8 @@ server
Immediately terminate the IRC server, after sending notices to all Immediately terminate the IRC server, after sending notices to all
connected clients and servers connected clients and servers
**Note** .. note:: This command cannot be used remotely. The server name is
used only as a safety measure.
This command cannot be used remotely. The server name is used only
as a safety measure.
SET SET
--- ---
@ -513,7 +507,7 @@ H.S.
A server we have established a TCP connection to, but is not yet A server we have established a TCP connection to, but is not yet
registered. registered.
???? \?\?\?\?
An incoming connection that has not yet registered as a user or a An incoming connection that has not yet registered as a user or a
server (“unknown”). Shows the username, hostname, IP address and the server (“unknown”). Shows the username, hostname, IP address and the
time the connection has been open. It is possible that the ident or time the connection has been open. It is possible that the ident or

30
doc/oper-guide/config.rst
View file

@ -287,14 +287,12 @@ jupe\_exempt
resv\_exempt resv\_exempt
Users in this auth{} block may use reserved nicknames and channels. Users in this auth{} block may use reserved nicknames and channels.
**Note** .. note:: The initial nickname may still not be reserved.
The initial nickname may still not be reserved. flood\_exempt (\|) Users in this auth{} block may send arbitrary
amounts of commands per time unit to the server. This does not
flood\_exempt (\|) exempt them from any other flood limits. You should use this
Users in this auth{} block may send arbitrary amounts of commands setting with caution.
per time unit to the server. This does not exempt them from any
other flood limits. You should use this setting with caution.
no\_tilde (-) no\_tilde (-)
Users in this auth{} block will not have a tilde added to their Users in this auth{} block will not have a tilde added to their
@ -437,15 +435,13 @@ Connect blocks define what servers may connect or be connected to.
host host
The hostname or IP to connect to. The hostname or IP to connect to.
**Note** .. note:: Furthermore, if a hostname is used, it must have an ``A`` or
``AAAA`` record (no ``CNAME``) and it must be the primary hostname
for inbound connections to work.
Furthermore, if a hostname is used, it must have an A or AAAA IPv6 addresses must be in ``::`` shortened form; addresses which
record (no CNAME) and it must be the primary hostname for
inbound connections to work.
IPv6 addresses must be in :: shortened form; addresses which
then start with a colon must be prepended with a zero, for then start with a colon must be prepended with a zero, for
example 0::1. example ``0::1``.
send\_password send\_password
The password to send to the other server. The password to send to the other server.
@ -688,10 +684,8 @@ flags
another flags entry) will receive these flags. They are listed another flags entry) will receive these flags. They are listed
below. below.
**Note** .. note:: While they have the same names, the flags have subtly
different meanings from those in the cluster{} block.
While they have the same names, the flags have subtly different
meanings from those in the cluster{} block.
kline (K) kline (K)
Permanent and temporary K:lines Permanent and temporary K:lines

6
doc/oper-guide/oprivs.rst
View file

@ -73,10 +73,8 @@ servers, and the server argument on REHASH. This is only allowed if the
oper may perform the action locally, and if the remote server has a oper may perform the action locally, and if the remote server has a
shared{} block. shared{} block.
**Note** .. note:: If a cluster{} block is present, bans are sent remotely even
if the oper does not have oper:remoteban privilege.
If a cluster{} block is present, bans are sent remotely even if the
oper does not have oper:remoteban privilege.
oper:resv, channel control oper:resv, channel control
-------------------------- --------------------------

8
doc/oper-guide/ucommands.rst
View file

@ -74,9 +74,8 @@ FINDFORWARDS
FINDFORWARDS FINDFORWARDS
channel channel
**Note**
This command is only available if the ``m_findforwards.so`` .. note:: This command is only available if the ``m_findforwards.so``
extension is loaded. extension is loaded.
Displays which channels forward to the given channel (via cmode +f). If Displays which channels forward to the given channel (via cmode +f). If
@ -101,10 +100,9 @@ IDENTIFY
IDENTIFY IDENTIFY
parameters... parameters...
**Note**
This command is only available if the ``m_identify.so`` extension is .. note:: This command is only available if the ``m_identify.so``
loaded. extension is loaded.
Sends an identify command to either NickServ or ChanServ. If the first Sends an identify command to either NickServ or ChanServ. If the first
parameter starts with #, the command is sent to ChanServ, otherwise to parameter starts with #, the command is sent to ChanServ, otherwise to

241
doc/oper-guide/umodes.rst
View file

@ -1,63 +1,57 @@
User modes User modes
========== ==========
+a, server administrator ``+a``, server administrator
------------------------ ----------------------------
This vanity usermode is used to denote a server administrator in WHOIS This vanity usermode is used to denote a server administrator in WHOIS
output. All local “admin” privileges are independent of it, though output. All local “admin” privileges are independent of it, though
services packages may grant extra privileges to +a users. services packages may grant extra privileges to ``+a`` users.
+D, deaf ``+D``, deaf
-------- ------------
**Note** .. note:: This is a user umode, which anybody can set. It is not
specific to operators.
This is a user umode, which anybody can set. It is not specific to Users with the ``+D`` umode set will not receive messages sent to channels.
operators.
Users with the +D umode set will not receive messages sent to channels.
Joins, parts, topic changes, mode changes, etc are received as normal, Joins, parts, topic changes, mode changes, etc are received as normal,
as are private messages. as are private messages.
Support of this umode is indicated by the DEAF token in RPL\_ISUPPORT Support of this umode is indicated by the ``DEAF`` token in ``RPL_ISUPPORT``
(005); the parameter indicates the letter of the umode. Note that (005); the parameter indicates the letter of the umode. Note that
several common IRCD implementations have an umode like this (typically several common IRCD implementations have an umode like this (typically
+d) but do not have the token in 005. ``+d``) but do not have the token in 005.
+g, Caller ID ``+g``, Caller ID
------------- -----------------
**Note** .. note:: This is a user umode, which anybody can set. It is not
specific to operators.
This is a user umode, which anybody can set. It is not specific to Users with the ``+g`` umode set will only receive private messages
operators. 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
Users with the +g umode set will only receive private messages from private message, the target user will receive a rate-limited notice
users on a session-defined whitelist, defined by the /accept command. If saying that the user wishes to speak to them.
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.
Network operators are not affected by the callerid whitelist system in Network operators are not affected by the callerid whitelist system in
the event that they need to speak to users who have it enabled. the event that they need to speak to users who have it enabled.
Support of this umode is indicated by the CALLERID token in Support of this umode is indicated by the ``CALLERID`` token in
RPL\_ISUPPORT (005); the optional parameter indicates the letter of the ``RPL_ISUPPORT`` (005); the optional parameter indicates the letter of
umode, otherwise +g. the umode, otherwise ``+g``.
+i, invisible ``+i``, invisible
------------- -----------------
**Note** .. note:: This is a user umode, which anybody can set. It is not
specific to operators.
This is a user umode, which anybody can set. It is not specific to
operators.
Invisible users do not show up in WHO and NAMES unless you can see them. Invisible users do not show up in WHO and NAMES unless you can see them.
+l, receive locops ``+l``, receive locops
------------------ ----------------------
LOCOPS is a version of OPERWALL that is sent to opers on a single server 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 only. With cluster{} and shared{} blocks they can optionally be
@ -65,84 +59,77 @@ propagated further.
Unlike OPERWALL, any oper can send and receive LOCOPS. Unlike OPERWALL, any oper can send and receive LOCOPS.
+o, operator ``+o``, operator
------------ ----------------
This indicates global operator status. This indicates global operator status.
+Q, disable forwarding ``+Q``, disable forwarding
---------------------- --------------------------
**Note** .. note:: This is a user umode, which anybody can set. It is not
specific to operators.
This is a user umode, which anybody can set. It is not specific to
operators.
This umode prevents you from being affected by channel forwarding. If This umode prevents you from being affected by channel forwarding. If
enabled on a channel, channel forwarding sends you to another channel if enabled on a channel, channel forwarding sends you to another channel if
you could not join. See channel mode +f for more information. you could not join. See channel mode ``+f`` for more information.
+R, reject messages from unauthenticated users ``+R``, reject messages from unauthenticated users
---------------------------------------------- --------------------------------------------------
**Note** .. note:: This is a user umode, which anybody can set. It is not
specific to operators.
This is a user umode, which anybody can set. It is not specific to If a user has the ``+R`` umode set, then any users who are not authenticated
operators.
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 will receive an error message if they attempt to send a private message
or notice to the +R user. or notice to the ``+R`` user.
Opers and accepted users (like in +g) are exempt. Unlike +g, the target Opers and accepted users (like in ``+g``) are exempt. Unlike ``+g``, the target
user is not notified of failed messages. user is not notified of failed messages.
+s, receive server notices ``+s``, receive server notices
-------------------------- ------------------------------
This umode allows an oper to receive server notices. The requested types This umode allows an oper to receive server notices. The requested types
of server notices are specified as a parameter (“snomask”) to this of server notices are specified as a parameter (“snomask”) to this
umode. umode.
+S, network service ``+S``, network service
------------------- -----------------------
**Note** .. note:: This umode can only be set by servers named in a service{}
block.
This umode can only be set by servers named in a service{} block.
This umode grants various features useful for services. For example, This umode grants various features useful for services. For example,
clients with this umode cannot be kicked or deopped on channels, can clients with this umode cannot be kicked or deopped on channels, can
send to any channel, do not show channels in WHOIS, can be the target of send to any channel, do not show channels in WHOIS, can be the target of
services aliases and do not appear in /stats p. No server notices are services aliases and do not appear in /stats p. No server notices are
sent for hostname changes by services clients; server notices about sent for hostname changes by services clients; server notices about
kills are sent to snomask +k instead of +s. kills are sent to snomask ``+k`` instead of ``+s``.
The exact effects of this umode are variable; no user or oper on an The exact effects of this umode are variable; no user or oper on an
actual charybdis server can set it. actual charybdis server can set it.
+w, receive wallops ``+w``, receive wallops
------------------- -----------------------
**Note** .. note:: This is a user umode, which anybody can set. It is not
specific to operators.
This is a user umode, which anybody can set. It is not specific to Users with the ``+w`` umode set will receive WALLOPS messages sent by opers.
operators. Opers with ``+w`` additionally receive WALLOPS sent by servers (e.g. remote
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, various severe misconfigurations, many services CONNECT, remote SQUIT, various severe misconfigurations, many services
packages). packages).
+z, receive operwall ``+z``, receive operwall
-------------------- ------------------------
OPERWALL differs from WALLOPS in that the ability to receive such OPERWALL differs from WALLOPS in that the ability to receive such
messages is restricted. Opers with +z set will receive OPERWALL messages is restricted. Opers with ``+z`` set will receive OPERWALL
messages. messages.
+Z, SSL user ``+Z``, SSL user
------------ ----------------
This umode is set on clients connected via SSL/TLS. It cannot be set or This umode is set on clients connected via SSL/TLS. It cannot be set or
unset after initial connection. unset after initial connection.
@ -154,7 +141,7 @@ Usage is as follows:
MODE MODE
nick nick
+s ``+s``
+/-flags +/-flags
To set snomasks. To set snomasks.
@ -163,132 +150,128 @@ nick
-s -s
To clear all snomasks. To clear all snomasks.
Umode +s will be set if at least one snomask is set. Umode ``+s`` will be set if at least one snomask is set.
Umode +s is oper only by default, but even if you allow nonopers to set Umode ``+s`` is oper only by default, but even if you allow nonopers to set
it, they will not get any server notices. it, they will not get any server notices.
Meanings of server notice masks Meanings of server notice masks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+b, bot warnings ``+b``, bot warnings
---------------- --------------------
Opers with the +b snomask set will receive warning messages from the Opers with the ``+b`` snomask set will receive warning messages from the
server when potential flooders and spambots are detected. server when potential flooders and spambots are detected.
+c, client connections ``+c``, client connections
---------------------- --------------------------
Opers who have the +c snomask set will receive server notices when Opers who have the ``+c`` snomask set will receive server notices when
clients attach to the local server. clients attach to the local server.
+C, extended client connection notices ``+C``, extended client connection notices
-------------------------------------- ------------------------------------------
Opers who have the +C snomask set will receive server notices when Opers who have the ``+C`` snomask set will receive server notices when
clients attach to the local server. Unlike the +c snomask, the clients attach to the local server. Unlike the ``+c`` snomask, the
information is displayed in a format intended to be parsed by scripts, information is displayed in a format intended to be parsed by scripts,
and includes the two unused fields of the USER command. and includes the two unused fields of the USER command.
+d, debug ``+d``, debug
--------- -------------
The +d snomask provides opers extra information which may be of interest 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 to debuggers. It will also cause the user to receive server notices if
certain assertions fail inside the server. Its precise meaning is certain assertions fail inside the server. Its precise meaning is
variable. Do not depend on the effects of this snomask as they can and variable. Do not depend on the effects of this snomask as they can and
will change without notice in later revisions. will change without notice in later revisions.
+f, full warning ``+f``, full warning
---------------- --------------------
Opers with the +f snomask set will receive notices when a user Opers with the ``+f`` snomask set will receive notices when a user
connection is denied because a connection limit is exceeded (one of the 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 limits in a class{} block, or the total per-server limit settable with
/quote set max). /quote set max).
+F, far client connection notices ``+F``, far client connection notices
--------------------------------- -------------------------------------
**Note** .. note:: This snomask is only available if the ``sno_farconnect.so``
This snomask is only available if the ``sno_farconnect.so``
extension is loaded. extension is loaded.
Opers with +F receive server notices when clients connect or disconnect Opers with ``+F`` receive server notices when clients connect or disconnect
on other servers. The notices have the same format as those from the +c on other servers. The notices have the same format as those from the ``+c``
snomask, except that the class is ? and the source server of the notice snomask, except that the class is ? and the source server of the notice
is the server the user is/was on. is the server the user is/was on.
No notices are generated for netsplits and netjoins. Hence, these No notices are generated for netsplits and netjoins. Hence, these
notices cannot be used to keep track of all clients on the network. notices cannot be used to keep track of all clients on the network.
There is no far equivalent of the +C snomask. There is no far equivalent of the ``+C`` snomask.
+k, server kill notices ``+k``, server kill notices
----------------------- ---------------------------
Opers with the +k snomask set will receive server notices when services 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 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. UID) users. Kills and saves by this server are on ``+d`` or ``+s``.
+n, nick change notices ``+n``, nick change notices
----------------------- ---------------------------
An oper with +n set will receive a server notice every time a local user 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 changes their nick, giving the old and new nicks. This is mostly useful
for bots that track all users on a single server. for bots that track all users on a single server.
+r, notices on name rejections ``+r``, notices on name rejections
------------------------------ ----------------------------------
Opers with this snomask set will receive a server notice when somebody 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 tries to use an invalid username, or if a dumb HTTP proxy tries to
connect. connect.
+s, generic server notices ``+s``, generic server notices
-------------------------- ------------------------------
This snomask allows an oper to receive generic server notices. This This snomask allows an oper to receive generic server notices. This
includes kills from opers (except services). includes kills from opers (except services).
+u, unauthorized connections ``+u``, unauthorized connections
---------------------------- --------------------------------
This snomask allows an oper to see when users try to connect who do not This snomask allows an oper to see when users try to connect who do not
have an available auth{} block. have an available auth{} block.
+W, whois notifications ``+W``, whois notifications
----------------------- ---------------------------
**Note** .. note:: This snomask is only available if the ``sno_whois.so``
extension is loaded.
This snomask is only available if the ``sno_whois.so`` extension is Opers with ``+W`` receive notices when a WHOIS is executed on them on their
loaded.
Opers with +W receive notices when a WHOIS is executed on them on their
server (showing idle time). server (showing idle time).
+x, extra routing notices ``+x``, extra routing notices
------------------------- -----------------------------
Opers who have the +x snomask set will get notices about servers Opers who have the ``+x`` snomask set will get notices about servers
connecting and disconnecting on the whole network. This includes all connecting and disconnecting on the whole network. This includes all
servers connected behind the affected link. This can get rather noisy servers connected behind the affected link. This can get rather noisy
but is useful for keeping track of all linked servers. but is useful for keeping track of all linked servers.
+y, spy ``+y``, spy
------- -----------
Opers with +y receive notices when users try to join RESV'ed (“juped”) Opers with ``+y`` receive notices when users try to join RESV'ed (“juped”)
channels. Additionally, if certain extension modules are loaded, they channels. Additionally, if certain extension modules are loaded, they
will receive notices when special commands are used. will receive notices when special commands are used.
+Z, operspy notices ``+Z``, operspy notices
------------------- -----------------------
Opers with +Z receive notices whenever an oper anywhere on the network Opers with ``+Z`` receive notices whenever an oper anywhere on the network
uses operspy. uses operspy.
This snomask can be configured to be only effective for admins. This snomask can be configured to be only effective for admins.