aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Sadie Powell2026-03-09 18:15:39 +0000
committerGravatar Sadie Powell2026-03-09 18:15:39 +0000
commit7c014d8ca4796fc48d58f54517a5101356349eb0 (patch)
tree8cb8a82903d55c51a5cc99e96d453b864b1a44ba /docs
parentAdd a new version of mkauthors written in Python. (diff)
parentAdd a redirect extended ban to the redirect module. (diff)
Merge branch 'insp4' into master.
Diffstat (limited to 'docs')
-rw-r--r--docs/conf/help.example.conf147
-rw-r--r--docs/conf/modules.example.conf16
2 files changed, 103 insertions, 60 deletions
diff --git a/docs/conf/help.example.conf b/docs/conf/help.example.conf
index aa9407d5d..796c01f95 100644
--- a/docs/conf/help.example.conf
+++ b/docs/conf/help.example.conf
@@ -1095,72 +1095,103 @@ x Notifications about X-lines being added/removed/expired on the local server
">
<helptopic key="extbans" title="Extended Bans" value="
-Extbans are split into two types; matching extbans, which match on
-users in additional ways, and acting extbans, which restrict users
-in different ways to a standard ban.
+Extended bans (extbans) are split into two types; matching extbans, which match on users in
+#additional ways, and acting extbans, which restrict users in different ways to a standard ban.
-To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
-instead of a normal nick!user@host mask, to ban or exempt matching
-users. Ban exceptions on acting extbans exempt that user from matching
-an extban of that type, and from any channel mode corresponding to the
-restriction. Matching extbans may also be used for invite exceptions by
-setting +I <extban>.
+To use an extban, simply set +b <ban> or +e <ban> with it as the ban, instead of a normal
+nick!user@host mask, to ban or exempt matching users. Ban exceptions on acting extbans exempt that
+user from matching an extban of that type, and from any channel mode corresponding to the
+restriction. Matching extbans may also be used for invite exceptions by setting +I <extban>.
+
+Extended bans can be specified either with their name (recommended) or by their character. You can
+also prefix an extban with ! to invert the match.
Matching extbans:
-realmask:<mask>, a:<mask> Matches user with both a matching banmask and real name, where
- <mask> is in the format nick!user@host+realname (requires the
- realnameban module).
-share:<channel>, b:<channel> Matches anyone on the given channel's ban list (requires the
- sharebans module).
-channel:<channel>, j:<channel> Matches anyone in the given channel. Supports wildcards
- (requires the channelban module).
-class:<class>, n:<class> Matches users in a matching connect class (requires the
- classban module).
-oper:<pattern>, o:<pattern> Checks whether users are logged into a server operator account
- with a name matching <pattern> (requires the operchans module).
-realname:<realname>, r:<realname> Matches users with a matching real name (requires the
- realnameban module).
-server:<server>, s:<server> Matches users on a matching server (requires the serverban
- module).
-sslfp:<tlsfp>, z:<tlsfp> Matches users having the given TLS certificate fingerprint
- (requires the sslmodes module).
-gateway:<gateway>, w:<gateway> Matches users who are connecting via a WebIRC gateway that
- matches <gateway> (requires the gateway module).
-country:<pattern>, G:<pattern> Matches against the two letter country code for the country
- that users are connecting from (requires the geoban module).
-opertype:<opertype>, O:<opertype> Matches server operators of a matching type, mostly useful as
- an invite exception (requires the operchans module).
-account:<account>, R:<account> Matches users logged into a matching account (requires the
- account module).
-unauthed:<banmask>, U:<banmask> Matches unregistered users matching the given banmask (requires
- the account module).
+[!]account:<glob> Matches users that have an account matching <glob>. If your services
+[!]R:<glob> has sent the owned nicknames to the IRCd this will also match against
+ all owned nicknames. This extban requires the account module.
+
+[!]channel:<prefix><glob> Matches users that have <prefix> on a channel matching <glob>. This
+[!]j:<glob> extban requires the channelban module.
+
+[!]class:<glob> Matches users that are in a connect class matching <glob>. All spaces
+[!]n:<glob> in the class name are replaced with underscores before matching.
+ This extban requires the classban module.
+
+[!]country:<glob> Matches users connecting from a country whose ISO 3166-1 alpha-2 code
+[!]G:<glob> matches <glob>. This extban requires the geoban module.
+
+[!]fingerprint:<glob> Matches users that are using a TLS certificate with a fingerprint that
+[!]z:<glob> matches <glob>. This extban requires the sslmodes module.
+
+[!]gateway:<glob> Matches users connecting through a WebIRC gateway matching <glob>.
+[!]w:<glob> This extban requires the webirc module.
+
+[!]oper:<glob> Matches users that are logged into a server operator account matching
+[!]o:<glob> <glob>. All spaces in the account name are replaced with underscores
+ before matching. This extban requires the operchans module.
+
+[!]opertype:<glob> Matches users that are logged into a server operator account with a
+[!]O:<glob> type matching <glob>. All spaces in the operator type name are replaced
+ with underscores before matching. This extban requires the operchans
+ module.
+
+[!]realmask:<mglob>+<rglob> Matches users that have a nick!user@host mask matching <mglob> and a
+[!]a:<mglob>+<rglob> real name matching <rglob>. All spaces in the real name are replaced
+ with underscores before matching. This extban requires the realnameban
+ module.
+
+[!]realname:<glob> Matches users that have a real name matching <glob>. All spaces in the
+[!]r:<glob> real name are replaced with underscores before matching. This extban
+ requires the realnameban module.
+
+[!]server:<glob> Matches users that are connected to a server matching <glob>. This
+[!]s:<glob> extban requires the serverban module.
+
+[!]share:<chan> Matches users that are banned from <chan>. This extban requires the
+[!]b:<chan> sharebans module.
+
+unauthed:<glob> Matches users that have a nick!user@host mask matching <glob>. This
+U:<glob> extban requires the account module.
Acting extbans:
-blockcolor:<banmask>, c:<banmask> Blocks any messages that contain formatting codes from matching
- users (requires the blockcolor module).
-mute:<banmask>, m:<banmask> Blocks messages from matching users (requires the muteban
- module). Users with +v or above are not affected.
-opmoderated:<banmask>, u:<banmask> Blocks matching users from speaking to unprivileged users in
- the channel (requires the opmoderated module).
-blockinvite:<banmask>, A:<banmask> Blocks invites by matching users even when +A is set (requires
- the allowinvite module).
-noctcp:<banmask>, C:<banmask> Blocks CTCPs from matching users (requires the noctcp module).
-nonick:<banmask>, N:<banmask> Blocks nick changes from matching users (requires the nonicks
- module).
-nokick:<banmask>, Q:<banmask> Blocks kicks by matching users (requires the nokicks module).
-stripcolor:<banmask>, S:<banmask> Strips formatting codes from messages from matching users
- (requires the stripcolor module).
-nonotice:<banmask>, T:<banmask> Blocks notices from matching users (requires the nonotice
- module).
+[!]blockcolor:<glob> Prevents users matching <glob> from sending messages containing IRC
+[!]c:<glob> formatting codes to the channel. This extban requires the blockcolor
+ module.
+
+[!]blockinvite:<glob> Prevents users matching <glob> from sending invites when channel mode
+[!]A<glob> +A (allowinvite) is set. This extban requires the allowinvite module.
+
+[!]mute:<glob> Prevents users matching <glob> from sending messages to the channel.
+[!]m:<glob> This extban requires the muteban module.
+
+[!]noctcp:<glob> Prevents users matching <glob> from sending CTCPs to the channel.
+[!]C:<glob> This extban requires the noctcp module.
+
+[!]nokick:<glob> Prevents users matching <glob> from kicking users from the channel.
+[!]Q:<glob> This extban requires the nokicks module.
+
+[!]nonick:<glob> Prevents users matching <glob> from changing their nickname whilst on
+[!]N:<glob> the channel. This extban requires the nonicks module.
+
+[!]nonotice:<glob> Prevents users matching <glob> from sending notice messages to the
+[!]T:<glob> channel. This extban requires the nonotice module.
+
+[!]opmoderated:<glob> Prevents messages sent by users matching <glob> from being visible to
+[!]u:<glob> unprivileged users. This extban requires the opmoderated module.
+
+[!]redirect:<chan>:<glob> Redirects users matching <glob> to <chan>. This extban requires the
+ redirect module.
-A ban given to an Acting extban may either be a nick!user@host mask
-(unless stated otherwise), matched against users as for a normal ban,
-or a Matching extban.
+[!]stripcolor:<glob> Removes IRC formatting codes from messages sent by users matching
+[!]S:<glob> <glob>. This extban requires the stripcolor module.
-There is an additional special type of extended ban, a redirect ban:
+A glob given to an acting extban may (unless stated otherwise) be either a matching extban or a
+#nick!user@host mask matched against users as if they were a regular ban.
- Redirect n!u@h#channel will redirect the banned user to #channel
- when they try to join (requires the banredirect module).
+There is an additional special type of ban, a redirect ban. For a redirect ban a ban mask in the
+format nick!user@host#channel will redirect the banned user to #channel when they try to join. This
+requires the banredirect module.
">
diff --git a/docs/conf/modules.example.conf b/docs/conf/modules.example.conf
index 1fa2a73a2..c75178c98 100644
--- a/docs/conf/modules.example.conf
+++ b/docs/conf/modules.example.conf
@@ -194,6 +194,10 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Ban redirection module: Allows bans which redirect to a specified
# channel. e.g. +b nick!user@host#channelbanneduserissentto
+#
+# WARNING: This module is deprecated and will be removed in the next
+# version of InspIRCd. It is recommended that you load the redirect
+# module and enable <redirect:extban> instead.
#<module name="banredirect">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1981,9 +1985,17 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Redirect module: Adds channel mode +L which redirects users to #
-# another channel when the channel has reached its user limit and #
-# user mode +L which stops redirection. #
+# another channel when the user can not join and user mode +L which #
+# prevents redirection. #
#<module name="redirect">
+#
+# You can also configure which modes which will redirect the user to
+# the target channel:
+#<redirect ban="no"
+# extban="no"
+# inviteonly="yes"
+# key="yes"
+# limit="yes">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Regular expression provider for glob or wildcard (?/*) matching.