summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRobby <Robby-@users.noreply.github.com>2019-04-28 10:14:21 +0200
committerPeter Powell <petpow@saberuk.com>2019-04-28 09:14:21 +0100
commite57d1b19ff4823b7885eb7f4d3b37c84d2edca0e (patch)
tree81e3825243464f332742b7e945053d32d726808b /docs
parent2533dc10f987eedb99d780c7debd948f22705679 (diff)
Textual improvements and fixes such as typos, casing, etc. (#1612)
Diffstat (limited to 'docs')
-rw-r--r--docs/conf/helpop.conf.example63
-rw-r--r--docs/conf/inspircd.conf.example8
-rw-r--r--docs/conf/modules.conf.example38
-rw-r--r--docs/conf/opers.conf.example4
-rw-r--r--docs/conf/quotes.txt.example2
5 files changed, 59 insertions, 56 deletions
diff --git a/docs/conf/helpop.conf.example b/docs/conf/helpop.conf.example
index c0dbdc45f..e12508659 100644
--- a/docs/conf/helpop.conf.example
+++ b/docs/conf/helpop.conf.example
@@ -79,7 +79,7 @@ format are optional.">
<helpop key="accept" value="/ACCEPT *|(+|-)<nick>[,(+|-)<nick>]+
Manages your accept list. This list is used to determine who can
-private message you when you have usermode +g set.
+private message you when you have user mode +g set.
/ACCEPT * - List accepted nicks
/ACCEPT +<nick> - Add a nick
@@ -145,7 +145,7 @@ E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.">
This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
which caused trouble for some users.">
-<helpop key="silence" value="/SILENCE [(+|-)<mask> [CcdiNnPpsTtx]+]
+<helpop key="silence" value="/SILENCE [(+|-)<mask> [CcdiNnPpTtx]]
A server-side ignore of the given n!u@h mask. If the optional flags field is
specified then it must contain one or more flags which specify what kind of
@@ -157,16 +157,16 @@ messages should be blocked and how they should be blocked.
Valid SILENCE Flags
-------------------
- c Matches a CTCP targeted at a channel.
C Matches a CTCP targeted at a user.
+ c Matches a CTCP targeted at a channel.
d Default behaviour; equivalent to CciNnPpTt.
i Matches an invite to a channel.
- n Matches a NOTICE targeted at a channel.
N Matches a NOTICE targeted at a user.
- p Matches a PRIVMSG targeted at a channel.
+ n Matches a NOTICE targeted at a channel.
P Matches a PRIVMSG targeted at a user.
- t Matches a TAGMSG targeted at a channel.
+ p Matches a PRIVMSG targeted at a channel.
T Matches a TAGMSG targeted at a user.
+ t Matches a TAGMSG targeted at a channel.
x Exempt the mask from silence rules.
Any combination of flags is valid.">
@@ -243,7 +243,7 @@ Change or view modes of <target>.
Sets the mode for a channel or a nickname specified in <target>.
A user may only set modes upon themselves, and may not set the
-+o usermode, and a user may only change channel modes of
++o user mode, and a user may only change channel modes of
channels where they are at least a halfoperator.
For a list of all user and channel modes, enter /HELPOP UMODES or
@@ -343,10 +343,10 @@ to using a server.">
<helpop key="oper" value="/OPER <username> <password>
-Attempts to authenticate a user as an IRC operator.
+Attempts to authenticate as a server operator.
Both successful and unsuccessful oper attempts are
-logged, and sent to online IRC operators.">
+logged, and sent to online server operators.">
<helpop key="list" value="/LIST [<pattern>]
@@ -461,8 +461,8 @@ Returns the IP address and nickname of the given user(s).">
This command returns the number of local and global clients matched,
and the percentage of clients matched, plus how they were matched
-(by IP address or by hostname). Mask should be given as either a
-nick!user@host or user@IP (wildcards accepted).">
+(by IP address or by hostname). Mask should be given as either
+nick!user@host or user@IP (wildcards and CIDR blocks are accepted).">
<helpop key="lockserv" value="/LOCKSERV [:<message>]
@@ -488,11 +488,11 @@ Valid FILTER Actions
--------------------
None Does nothing
-Warn Lets the message through and informs +s IRCops of the message
- and all relevant info
-Block Blocks message and informs +s IRCops of the blocked message
- and all relevant info
-Silent Blocks message, but does not notify IRCops
+Warn Lets the message through and informs +s server operators
+ of the message and all relevant info
+Block Blocks message and informs +s server operators of the blocked
+ message and all relevant info
+Silent Blocks message, but does not notify server operators
Kill Kills the user
Gline G-lines the user for the specified duration
Zline Z-lines the user for the specified duration
@@ -832,16 +832,16 @@ using their cloak when they quit.">
from channels they are in (requires the deaf module).
g In combination with /ACCEPT, provides for server-side
ignore (requires the callerid module).
- h Marks as 'available for help' in WHOIS (IRCop only,
- requires the helpop module).
+ h Marks as 'available for help' in WHOIS (server operators
+ only, requires the helpop module).
i Makes invisible to /WHO if the user using /WHO is not in
a common channel.
k Prevents the user from being kicked from channels, or
having op modes removed from them (services only,
requires the servprotect module).
- o Marks as a IRC operator.
+ o Marks as a server operator.
s <mask> Receives server notices specified by <mask>
- (IRCop only).
+ (server operators only).
r Marks as a having a registered nickname
(requires the services account module).
w Receives wallops messages.
@@ -856,15 +856,15 @@ using their cloak when they quit.">
H Hides an oper's oper status from WHOIS (requires the
hideoper module).
I Hides a user's entire channel list in WHOIS from
- non-IRCops (requires the hidechans module).
+ non-server operators (requires the hidechans module).
L Stops redirections done by the redirect module (requires
the redirect module).
R Blocks private messages from unregistered users
(requires the services account module).
S Strips formatting codes out of private messages
to the user (requires the stripcolor module).
- W Receives notification when a user uses WHOIS on them
- (IRCop only, requires the showwhois module).">
+ W Receives notifications when a user uses WHOIS on them
+ (server operators only, requires the showwhois module).">
<helpop key="chmodes" value="Channel Modes
-------------
@@ -963,12 +963,12 @@ using their cloak when they quit.">
the services account module).
N Prevents users on the channel from changing nick
(requires the nonicks module).
- O Channel is IRCops only (can only be set by IRCops,
- requires the operchans module).
+ O Channel is server operators only (can only be set
+ by server operators, requires the operchans module).
P Makes the channel permanent; Bans, invites, the
topic, modes, and such will not be lost when it
- empties (can only be set by IRCops, requires
- the permchannels module).
+ empties (can only be set by server operators,
+ requires the permchannels module).
Q Only U-lined servers and their users can kick
(requires the nokicks module).
R Blocks unregistered users from joining (requires
@@ -1042,7 +1042,7 @@ E Show socket engine events
S Show currently held registered nicknames
G Show how many local users are connected from each country
-Note that all /STATS use is broadcast to online IRC operators.">
+Note that all /STATS use is broadcast to online server operators.">
<helpop key="snomasks" value="Server Notice Masks
@@ -1090,7 +1090,7 @@ setting +I <extban>.
Matching extbans:
- a:<mask> Matches user with both a matching banmask and realname,
+ a:<mask> Matches user with both a matching banmask and real name,
where <mask> is in the format nick!user@host+realname
(requires gecosban module).
j:<channel> Matches anyone in the given channel. Does not support
@@ -1103,8 +1103,9 @@ Matching extbans:
serverban module).
z:<certfp> Matches users having the given SSL certificate
fingerprint (requires the sslmodes module).
- O:<opertype> Matches IRCops of a matching type, mostly useful as an
- an invite exception (requires the operchans module).
+ O:<opertype> Matches server operators of a matching type, mostly
+ useful as an invite exception (requires the
+ operchans module).
R:<account> Matches users logged into a matching account (requires
the services account module).
U:<banmask> Matches unregistered users matching the given banmask.
diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example
index e3f3185d5..3e9c47da2 100644
--- a/docs/conf/inspircd.conf.example
+++ b/docs/conf/inspircd.conf.example
@@ -298,7 +298,7 @@
# limit: How many users are allowed in this class
limit="5000"
- # modes: Usermodes that are set on users in this block on connect.
+ # modes: User modes that are set on users in this block on connect.
# Enabling this option requires that the conn_umodes module be loaded.
# This entry is highly recommended to use for/with IP cloaking/masking.
# For the example to work, this also requires that the cloaking
@@ -412,7 +412,7 @@
# limit: How many users are allowed in this class
limit="5000"
- # modes: Usermodes that are set on users in this block on connect.
+ # modes: User modes that are set on users in this block on connect.
# Enabling this option requires that the conn_umodes module be loaded.
# This entry is highly recommended to use for/with IP cloaking/masking.
# For the example to work, this also requires that the cloaking
@@ -772,7 +772,7 @@
restrictbannedusers="yes"
# genericoper: Setting this value to yes makes all opers on this server
- # appear as 'is an IRC operator' in their WHOIS, regardless of their
+ # appear as 'is a server operator' in their WHOIS, regardless of their
# oper type, however oper types are still used internally. This only
# affects the display in WHOIS.
genericoper="no"
@@ -945,7 +945,7 @@
<exception
# host: ident@hostname to exempt.
# Wildcards and CIDR (if you specify an IP) can be used.
- host="*@ircop.example.com"
+ host="*@serverop.example.com"
# reason: Reason for exception. Only shown in /STATS e.
reason="Oper's hostname">
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index fe189e7c4..4b72ab227 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -117,9 +117,9 @@
# the user receives a 'no such nick' 401 numeric. #
# #
# uline - Setting this to true will ensure that the user #
-# given in 'requires' is also on a u-lined server, #
+# given in 'requires' is also on a U-lined server, #
# as well as actually being on the network. If the #
-# user is online, but not on a u-lined server, #
+# user is online, but not on a U-lined server, #
# then an oper alert is sent out as this is #
# possibly a sign of a user trying to impersonate #
# a service. #
@@ -282,7 +282,7 @@
#<module name="botmode">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# CallerID module: Adds usermode +g which activates hybrid-style
+# CallerID module: Adds user mode +g which activates hybrid-style
# callerid: block all private messages unless you /ACCEPT first.
#<module name="callerid">
#
@@ -510,7 +510,7 @@
#<module name="clearchan">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Cloaking module: Adds usermode +x and cloaking support.
+# Cloaking module: Adds user mode +x and cloaking support.
# Relies on the md5 module being loaded.
# To cloak users when they connect, load the conn_umodes module and set
# <connect:modes> to include the +x mode. The example <connect> tag
@@ -719,7 +719,7 @@
#<banfile pattern="*.txt" action="allow">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Deaf module: Adds support for the usermodes +dD:
+# Deaf module: Adds support for user modes +d and +D:
# d - deaf to channel messages and notices.
# D - deaf to user messages and notices.
# The +D user mode is not enabled by default to enable link compatibility
@@ -733,8 +733,8 @@
# the starting character of a message.
# If 'bypasscharsuline' is empty, then 'bypasschars' will
# match for both regular and U-lined users.
-# enableprivdeaf - Whether to enable usermode +D (privdeaf).
-# privdeafuline - Whether U-lined users bypass usermode +D (privdeaf).
+# enableprivdeaf - Whether to enable user mode +D (privdeaf).
+# privdeafuline - Whether U-lined users bypass user mode +D (privdeaf).
#
#<deaf bypasschars="" bypasscharsuline="!" enableprivdeaf="no" privdeafuline="yes">
@@ -1499,26 +1499,26 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Oper prefixing module: Adds a channel prefix mode +y which is given
-# to all IRC operators automatically on all channels they are in.
+# to all server operators automatically on all channels they are in.
# This prefix mode is more powerful than channel op and other regular
# prefix modes.
#
-# Load this module if you want all your IRC operators to have channel
-# operator powers.
+# Load this module if you want all your server operators to have
+# channel operator powers.
#<module name="operprefix">
#
# You may additionally customise the prefix character.
#<operprefix prefix="!">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper MOTD module: Provides support for separate message of the day
+# Oper MOTD module: Provides support for a separate message of the day
# on oper-up.
# This module is oper-only.
#<module name="opermotd">
#
#-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
# #
-# If you are using the opermotd module, specify the motd here. #
+# If you are using the opermotd module, specify the motd file here. #
# #
# onoper - If on, the message is sent on /OPER, otherwise it's #
# only sent when /OPERMOTD is used. #
@@ -1540,9 +1540,9 @@
# via channel notice. #
# #
# requirekey - If enabled, overriding on join requires a channel #
-# key of "override" to be specified #
+# key of "override" to be specified. #
# #
-# enableumode - If enabled, usermode +O is required for override. #
+# enableumode - If enabled, user mode +O is required for override. #
# #
#<override noisy="yes" requirekey="no" enableumode="true">
@@ -1807,13 +1807,15 @@
# If you wish to re-check a user when they change nickname (can be
# useful under some situations, but *can* also use CPU with more users
# on a server) then set 'matchonnickchange' to yes.
+# If you additionally want Z-lines to be added on matches, then
+# set 'zlineonmatch' to yes.
# Also, this is where you set what Regular Expression engine is to be
# used. If you ever change it while running, all of your R-lines will
# be wiped. This is the regex engine used by all R-lines set, and
# regex_<engine> must be loaded, or rline will be non-functional
# until you load it or change the engine to one that is loaded.
#
-#<rline matchonnickchange="yes" engine="pcre">
+#<rline matchonnickchange="yes" zlineonmatch="no" engine="pcre">
#
# Generally, you will NOT want to use 'glob' here, as this turns an
# R-line into just another G-line. The exceptions are that R-lines will
@@ -1931,7 +1933,7 @@
#<module name="setidle">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Services support module: Adds several usermodes such as +R and +M.
+# Services support module: Adds several user modes such as +R and +M.
# This module implements the 'identified' state via account names,
# and is similar in operation to the way asuka and ircu handle services.
#
@@ -2018,7 +2020,7 @@
# endtext="End of server rules.">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Show whois module: Adds the +W usermode which allows opers to see
+# Show whois module: Adds the +W user mode which allows opers to see
# when they are /WHOIS'd.
# This module is oper-only by default.
#<module name="showwhois">
@@ -2274,7 +2276,7 @@
# <wsorigin allow="https://*.example.com/">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# XLine database: Stores all *-lines (G/Z/K/R/any added by other modules)
+# X-line database: Stores all *-lines (G/Z/K/R/any added by other modules)
# in a file which is re-loaded on restart. This is useful
# for two reasons: it keeps bans so users may not evade them, and on
# bigger networks, server connections will take less time as there will
diff --git a/docs/conf/opers.conf.example b/docs/conf/opers.conf.example
index 685a252ca..7cad2589c 100644
--- a/docs/conf/opers.conf.example
+++ b/docs/conf/opers.conf.example
@@ -44,7 +44,7 @@
# *NOTE: These privs are potentially dangerous, as they grant users with them the ability to hammer your server's CPU/RAM as much as they want, essentially.
privs="users/auspex channels/auspex servers/auspex users/mass-message users/flood/no-throttle users/flood/increased-buffers"
- # usermodes: Oper-only usermodes that opers with this class can use.
+ # usermodes: Oper-only user modes that opers with this class can use.
usermodes="*"
# chanmodes: Oper-only channel modes that opers with this class can use.
@@ -82,7 +82,7 @@
# Requires the opermodes module to be loaded.
modes="+s +cCqQ">
-<type name="GlobalOp" classes="SACommands OperChat BanControl HostCloak ServerLink" vhost="ircop.omega.example.org">
+<type name="GlobalOp" classes="SACommands OperChat BanControl HostCloak ServerLink" vhost="serverop.omega.example.org">
<type name="Helper" classes="HostCloak" vhost="helper.omega.example.org">
diff --git a/docs/conf/quotes.txt.example b/docs/conf/quotes.txt.example
index 56a580e33..c07e1379a 100644
--- a/docs/conf/quotes.txt.example
+++ b/docs/conf/quotes.txt.example
@@ -82,7 +82,7 @@ It just keeps going and going and going and going and goi <BANG>
All that I know is that nukes are comming from 127.0.0.1
I know all about the irc and the mirc cops.
M re ink n ed d, ple s r fil
-Please refrain from feeding the IRC Operators. Thank you.
+Please refrain from feeding the server operators. Thank you.
I know all about mirc stuff, hmm.. I think this channel is experiencing packet loss..
MacDonalds claims Macintosh stole their next idea of the iMac
I can't hold her any longer, captain, she's gonna bl.. sorry, got caught up in the moment