X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fmodules.conf.example;h=2282449800a04ace235d96811c4d44a851253d1e;hb=712c32ab4855806b9981d34a4301a33763acf974;hp=0ab0c7451585855d51093d79cc47890a5852d875;hpb=131f659d91953c51823ef70c8314aa3170ce7a7e;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index 0ab0c7451..228244980 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -78,13 +78,13 @@ # matched, or it has no format value. Aliases are # # read from the top of the file to the bottom. # # # -# usercommand - If this is true, the alias can be run simply as # -# /ALIASNAME. Defaults to true. # +# usercommand - If set to yes, the alias can be run simply as # +# /ALIASNAME. Defaults to yes. # # # -# channelcommand - If this is true, the alias can be used as an # +# channelcommand - If set to yes, the alias can be used as an # # in-channel alias or 'fantasy command', prefixed # # by the fantasy prefix character, !aliasname by # -# default. Defaults to false. # +# default. Defaults to no. # # # # format - If this is defined, the parameters of the alias # # must match this glob pattern. For example if you # @@ -116,11 +116,11 @@ # to successfully trigger. If they are not, then # # the user receives a 'no such nick' 401 numeric. # # # -# stripcolor - If this is true, the text from the user will be # +# stripcolor - If set to yes, the text from the user will be # # stripped of color and format codes before # # matching against 'text'. # # # -# uline - Setting this to true will ensure that the user # +# uline - Setting this to yes will ensure that the user # # 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, # @@ -128,7 +128,7 @@ # possibly a sign of a user trying to impersonate # # a service. # # # -# operonly - If true, this will make the alias oper only. # +# operonly - If yes, this will make the alias oper only. # # If a non-oper attempts to use the alias, it will # # appear to not exist. # # # @@ -338,6 +338,9 @@ # This module is oper-only and provides /CBAN. # To use, CBAN must be in one of your oper class blocks. # +# CBAN does not allow glob channelmasks by default for compatibility +# reasons. You can enable glob support by uncommenting the next line. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Censor module: Adds channel and user mode +G which block phrases that @@ -1020,9 +1023,9 @@ # # # This mode can optionally prevent opers from seeing channels on a +I -# user, for more privacy if set to true. +# user, for more privacy if set to yes. # This setting is not recommended for most mainstream networks. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Hide list module: Allows for hiding the list of listmodes from users @@ -1144,10 +1147,10 @@ # the timeout for ident lookups here. If not defined, it will default # # to 5 seconds. This is a non-blocking timeout which holds the user # # in a 'connecting' state until the lookup is complete. # -# prefixunqueried: If on, the idents of users being in a connect class# -# with ident lookups disabled (i.e. ) will be # -# prefixed with a "~". If off, the ident of those users will not be # -# prefixed. Default is off. # +# prefixunqueried: If yes, the idents of users in a connect class # +# with ident lookups disabled (i.e. ) will be # +# prefixed with a "~". If no, the ident of those users will not be # +# prefixed. Default is no. # # # @@ -1173,7 +1176,7 @@ # The following block can be used to control which extensions are # enabled. Note that extended-join can be incompatible with delayjoin # and host cycling. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # IRCv3 account-tag module. Adds the 'account' tag which contains the @@ -1467,9 +1470,9 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# NAMESX module: Provides support for the NAMESX extension which allows -# clients to see all the prefixes set on a user without getting confused. -# This is supported by mIRC, x-chat, klient, and maybe more. +# NAMESX module: Provides support for the IRCv3 multi-prefix capability +# and legacy NAMESX extension which allow clients to see all the prefix +# modes set on a user. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1495,7 +1498,7 @@ # which allows up to X nick changes in Y seconds. # # -# The number of seconds to prevent nick changes for: +# The time period to prevent nick changes for: # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1588,8 +1591,8 @@ # # # If the following option is on then all oper commands will be sent to -# the snomask 'r'. The default is off. -# +# the snomask 'r'. The default is no. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper prefixing module: Adds a channel prefix mode +y which is given @@ -1728,8 +1731,8 @@ # whenever +P is set, unset, or the topic/modes on a +P channel is changed. # If you want to do this, set the filename below, and uncomment the include. # -# If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be -# saved. Defaults to false. +# If 'listmodes' is yes then all list modes (+b, +I, +e, +g...) will be +# saved. Defaults to no. # # 'saveperiod' determines how often to check if the database needs to be # saved to disk. Defaults to every five seconds. @@ -1841,8 +1844,8 @@ # in the same way as /REMOVE. # # -# supportnokicks: If true, /REMOVE is not allowed on channels where the -# nokicks (+Q) mode is set. Defaults to false. +# supportnokicks: If yes, /REMOVE is not allowed on channels where the +# nokicks (+Q) mode is set. Defaults to no. # protectedrank: Members having this rank or above may not be /REMOVE'd # by anyone. Set to 0 to disable this feature. Defaults to 50000. # @@ -2324,7 +2327,7 @@ # # SVSHOLD does not generate server notices by default, you can turn # notices on by uncommenting the next line. -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SWHOIS module: Allows you to add arbitrary lines to user WHOIS. @@ -2352,11 +2355,9 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# UHNAMES support module: Adds support for the IRCX style UHNAMES -# extension, which displays ident and hostname in the names list for -# each user, saving clients from doing a WHO on the channel. -# If a client does not support UHNAMES it will not enable it, this will -# not break incompatible clients. +# UHNAMES support module: Adds support for the IRCv3 userhost-in-names +# capability and legacy UHNAMES extension which display the ident and +# hostname of users in the NAMES list. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#