From 9704ccc8a62f0c79c8069078ae8139fcf2d3d681 Mon Sep 17 00:00:00 2001 From: Charles Kingsley Date: Sat, 29 Jan 2011 10:44:27 +0000 Subject: [PATCH] QA fixes / refinements for example.conf --- data/example.conf | 380 ++++++++++++++++++++++++++++++---------------- 1 file changed, 245 insertions(+), 135 deletions(-) diff --git a/data/example.conf b/data/example.conf index a7ee28943..d9bff8ce5 100644 --- a/data/example.conf +++ b/data/example.conf @@ -280,12 +280,17 @@ options * * The db_mysql_live module is an extension to db_mysql, and should only be used if * db_mysql is being used. This module pulls data in real time from SQL as it is - * requested by the core as a result of someone executing commands. This effectively - * allows you to edit your database and have it be immediatly refelected back on Anope. - * It is highly recommended you only use this module if your databases is located + * requested by the core as a result of someone executing commands. + * + * This effectively allows you to edit your database and have it be immediately + * reflected back in Anope. + * + * It is highly recommended you only use this module if your databases are located * locally as this module will generate many queries per command. * db_mysql_live only uses threads for commands and non-blocking queries, so it is safe to - * use on large networks without worrying about response time. + * use on large networks without worrying about response times. + * + * NOTE: You can and probably should use db_plain together with db_mysql/db_mysql_live * */ database = "db_plain" @@ -338,10 +343,12 @@ options /* * If set, Services will perform more stringent checks on passwords. If this * isn't set, Services will only disallow a password if it is the same as the - * entity (nickname or channel name) with which it is associated. When set, - * however, Services will also check that the password is at least five + * entity (nickname name) with which it is associated. When set, however, + * Services will also check that the password is at least five * characters long, and in the future will probably check other things - * as well. This directive is optional, but recommended. + * as well. + * + * This directive is optional, but recommended. */ strictpasswords = yes @@ -351,8 +358,9 @@ options * the given amount for any Services function or combination of functions * during a single IRC session (subject to badpasstimeout, below), Services * will issues a /KILL for the user. If not given, Services will ignore - * failed password attempts (though they will be logged in any case). This - * directive is optional, but recommended. + * failed password attempts (though they will be logged in any case). + * + * This directive is optional, but recommended. */ badpasslimit = 5 @@ -361,7 +369,9 @@ options * does not enter any incorrect passwords in this amount of time, the incorrect * password count will reset to zero. If not given, the timeout will be * disabled, and the incorrect password count will never be reset until the user - * disconnects. This directive is optional. + * disconnects. + * + * This directive is optional. */ badpasstimeout = 1h @@ -424,7 +434,9 @@ options /* * If set, Services will require a reason when a FORBID is added, else the * reason is optional. This directive also applies to SUSPENDed channels as - * well. This directive is optional. + * well. + * + * This directive is optional. */ forceforbidreason = yes @@ -432,10 +444,12 @@ options * If set, this will allow users to let Services send PRIVMSGs to them * instead of NOTICEs. Also see the defmsg option of nickserv:defaults, * which also toggles the default communication (PRIVMSG or NOTICE) to - * use for unregistered users. This directive is optional. + * use for unregistered users. * * This is a feature that is against the IRC RFC and should be used ONLY * if absolutely necessary. + * + * This directive is optional, and not recommended. */ #useprivmsg = yes @@ -458,7 +472,9 @@ options /* * If set, Services will send global messages on starting up and shutting - * down/restarting. This directive is optional. + * down/restarting. + * + * This directive is optional. */ #globaloncycle = yes @@ -477,13 +493,17 @@ options /* * If set, Services will hide the IRC operator's nick in a global - * message/notice. This directive is optional. + * message/notice. + * + * This directive is optional. */ #anonymousglobal = yes /* * Prevents users from registering their nick if they are not connected - * for at least the given number of seconds. This directive is optional. + * for at least the given number of seconds. + * + * This directive is optional. */ #nickregdelay = 30 @@ -491,28 +511,33 @@ options * If set, forbids the registration of nicks that contain an existing * nick with Services access. For example, if Tester is a Services Oper, * you can't register NewTester or Tester123 unless you are an IRC - * Operator. This directive is optional. + * Operator. * * NOTE: If you enable this, you will have to be logged in as an IRC * operator in order to register a Services Root nick when setting up * Anope for the first time. + * + * This directive is optional. */ #restrictopernicks = yes /* * The number of LOGON/OPER news items to display when a user logs on. - * This directive is optional, if left out, defaults to 3. + * + * This directive is optional, if no set it will default to 3. */ #newscount = 3 /* * A space-separated list of ulined servers on your network, it is assumed that * the servers in this list are allowed to set channel modes and Services will - * not attempt to reverse their mode changes. This directive is optional. + * not attempt to reverse their mode changes. * - * WARNING: Do NOT put your user servers in this directive. + * WARNING: Do NOT put your normal IRC user servers in this directive. + * + * This directive is optional. */ - ulineservers = "stats.your.network" + #ulineservers = "stats.your.network" /* * Default modes for mode lock, these are set on newly registered channels. @@ -521,19 +546,23 @@ options /* * Modes that will not be allowed to be locked. Oper only modes such as +O - * are always restricted from regular users and is not affected by this. + * are always restricted from regular users and are not affected by this. * Leave blank for no restrictions. */ nomlock = "z" /* * Modes to set on service bots when they join channels, comment this out for no modes + * + * This directive is optional. */ botmodes = "ao" /* * How many times services should attempt to reconnect to the uplink before giving up * Comment this out to never give up. + * + * This directive is optional. */ maxretries = 10 @@ -543,7 +572,7 @@ options retrywait = 60 /* - * If set, Services will hide commands that users doesn't have the privilege to execute + * If set, Services will hide commands that users doesn't have the privileges to execute * from HELP output. */ hideprivilegedcommands = no @@ -582,7 +611,7 @@ log /* * Enable to have the core services clients join and stay in the log channel(s) when logging. - * Note on some IRCds this is not optional, and is enforced on. + * Note: on some IRCds this is not optional, and is enforced on. */ inhabitlogchannel = yes @@ -637,8 +666,8 @@ log * This section is used to set up staff access to restricted oper only commands. * You may define groups of commands and privileges, as well as who may use them. * - * The block is recommended, as without it, you will be unable to access most oper commands. - * It replaces the old ServicesRoot directive, amongst others. + * This block is recommended, as without it you will be unable to access most oper commands. + * It replaces the old ServicesRoot directive amongst others. * * Note that third party modules may add additional commands and privileges to this list. * @@ -688,13 +717,13 @@ log * operserv/quit operserv/update operserv/reload operserv/restart * operserv/shutdown operserv/svsnick operserv/oline operserv/umode * - * First, we define 'opertypes', which are named whatever we want ('Network Administrator', etc). + * Firstly, we define 'opertypes' which are named whatever we want ('Network Administrator', etc). * These can contain commands for oper-only strings (see above) which grants access to that specific command, * and privileges (which grant access to more general permissions for the named area). * Wildcard entries are permitted for both, e.g. 'commands = "operserv/*"' for all OperServ commands. * * Below are some default example types, but this is by no means exhaustive, - * and it is recommended that you configure them to your liking. + * and it is recommended that you configure them to your needs. */ opertype @@ -783,20 +812,20 @@ mail { /* * If set, this option enables the mail commands in Services. You may choose - * to disable it if you have no Sendmail-compatible mailer installed. While + * to disable it if you have no Sendmail-compatible mailer installed. Whilst * this directive (and entire block) is optional, it is required if the * nickserv:emailregistration is set to yes. */ usemail = yes /* - * This is the command-line that will be used to call Sendmail to send an + * This is the command-line that will be used to call the mailer to send an * e-mail. It must be called with all the parameters needed to make it - * scan the mail input to find the mail recipient; consult your Sendmail + * scan the mail input to find the mail recipient; consult your mailer * documentation. * * Postfix users must use the compatible sendmail utility provided with - * it; this one usually needs no parameters on the command-line. Most + * it. This one usually needs no parameters on the command-line. Most * sendmail applications (or replacements of it) require the -t option * to be used. */ @@ -822,18 +851,21 @@ mail /* * This controls the minimum amount of time an user must wait before sending * another e-mail after they have sent one. It also controls the minimum time - * an user must wait before they can receive another e-mail. This directive - * is optional, but recommended. + * an user must wait before they can receive another e-mail. * * This feature prevents users from being mail bombed using Services and * it is highly recommended that it be used. + * + * This directive is optional, but highly recommended. */ delay = 5m /* * If set, Services will not attempt to put quotes around the TO: fields - * in e-mails. This directive is optional, and as far as we know, it's - * only needed if you are using ESMTP or QMail to send out e-mails. + * in e-mails. + * + * This directive is optional, and as far as we know, it's only needed + * if you are using ESMTP or QMail to send out e-mails. */ #dontquoteaddresses = yes } @@ -849,14 +881,14 @@ dns { /* * The nameserver to use for resolving hostnames, must be an IP or a resolver configuration file. - * The below should work fine on all nix like systems. Windows users will have to find their nameservers + * The below should work fine on all unix like systems. Windows users will have to find their nameservers * from ipconfig /all and put the IP here */ nameserver = "/etc/resolv.conf" #nameserver = "127.0.0.1" /* - * How long to wait before a DNS query has timed out + * How long to wait in seconds before a DNS query has timed out */ timeout = 5 } @@ -875,21 +907,23 @@ nickserv nick = "NickServ" /* - * The description of the NickServ client, which will be used as the GECOS (real - * name) of the client. + * The description of the NickServ client, which will be used as the GECOS + * (real name) of the client. */ description = "Nickname Registration Service" /* * The core modules to load for NickServ. This is a space separated list that corresponds - * to the base names of the modules for NickServ. This directive is optional, but highly recommended. + * to the base names of the modules for NickServ. + * + * This directive is optional, but highly recommended. */ modules = "ns_help ns_register ns_group ns_identify ns_access ns_set ns_saset ns_set_autoop ns_set_email ns_set_greet ns_set_hide ns_set_kill ns_set_language ns_set_message ns_set_private ns_set_secure ns_saset_noexpire ns_drop ns_recover ns_release ns_sendpass ns_ghost ns_alist ns_info ns_list ns_logout ns_status ns_update ns_getpass ns_getemail ns_forbid ns_suspend ns_resetpass ns_ajoin" /* - * Force users to give an e-mail address when they register a nick. This directive - * is recommended to be enabled, and required if the e-mail registration option is - * enabled. + * Force users to give an e-mail address when they register a nick. + * + * This directive is recommended to be enabled, and required if e-mail registration is enabled. */ forceemail = yes @@ -927,7 +961,7 @@ nickserv /* * A list of languages to load on startup that will be available in /nickserv set language. * Useful if you translate Anope to your language. (Explained further in docs/LANGUAGE). - * Note that english should not be listed here + * Note that english should not be listed here because it is the base language. */ languages = "ca_ES de_DE el_GR es_ES fr_FR hu_HU it_IT nl_NL pl_PL pt_PT ru_RU tr_TR" @@ -944,39 +978,45 @@ nickserv regdelay = 30s /* - * The minimum length of time between consecutive uses of NickServ's RESEND command. This - * directive is optional, but recommended. If not set, this restriction will be disabled. + * The minimum length of time between consecutive uses of NickServ's RESEND command. + * + * This directive is optional, but recommended. If not set, this restriction will be disabled. */ resenddelay = 90s /* - * The length of time before a nick registration expires. This directive is optional, but - * recommended. If not set, the default is 21 days. + * The length of time before a nick registration expires. + * + * This directive is optional, but recommended. If not set, the default is 21 days. */ expire = 21d /* - * The length of time before a suspended nick becomes unsuspended. This directive is optional. - * If not set, the default is to never. + * The length of time before a suspended nick becomes unsuspended. + * + * This directive is optional. If not set, the default is to never. */ #suspendexpire = 90d /* - * The lenth of time before a forbidden nick drops. This directive is optional. If not set, the - * default is to never. + * The lenth of time before a forbidden nick drops. + * + * This directive is optional. If not set, the default is to never. */ #forbidexpire = 90d /* * The length of time a user gets to enter the confirmation code which has been e-mailed - * to them before the nick will be released for general use again. This directive is - * only required if the e-mail registration option is enabled. + * to them before the nick will be released for general use again. + * + * This directive is only required if the e-mail registration option is enabled. */ #preregexpire = 1d /* - * The maximum number of nicks allowed in a group. This directive is optional, but - * recommended. If not set or set to 0, no limits will be applied. + * The maximum number of nicks allowed in a group. + * + * This directive is optional, but recommended. If not set or set to 0, no limits will be applied. */ maxaliases = 16 @@ -990,8 +1030,8 @@ nickserv * a user. Should be in the user@host format. If the host is not given, the one from ServicesUser * is used. */ - enforceruser = "enforcer@localhost.net" - #enforceruser = "enforcer" + enforceruser = "enforcer" + #enforceruser = "enforcer@localhost.net" /* * The delay before a NickServ collided nick is released. @@ -999,19 +1039,25 @@ nickserv releasetimeout = 1m /* - * Allow the use of the IMMED option in the NickServ SET KILL command. This directive is optional. + * Allow the use of the IMMED option in the NickServ SET KILL command. + * + * This directive is optional. */ #allowkillimmed = yes /* * If set, the NickServ GROUP command won't allow any group change. This is recommended for * better performance and to protect against nick stealing, however users will have less - * flexibility. This directive is optional. + * flexibility. + * + * This directive is optional, but recommended. */ #nogroupchange = yes /* - * Limits the use of the NickServ LIST command to IRC operators. This directive is optional. + * Limits the use of the NickServ LIST command to IRC operators. + * + * This directive is optional. */ #listopersonly = yes @@ -1028,21 +1074,25 @@ nickserv /* * Prevents the use of the DROP, FORBID, GETPASS, and SET PASSWORD commands by Services Admins - * on other Services Admins or the Services Root(s). This directive is optional, but - * recommended. + * on other Services Admins or the Services Root(s). + * + * This directive is optional, but recommended. */ secureadmins = yes /* * If set, any user wanting to use the privileges of Services Root, Services Admin, or Services - * Operator must have been logged as an IRC Operator with the /oper command. This directive is - * optional, but recommended. + * Operator must have been logged as an IRC Operator with the /oper command. + * + * This directive is optional, but recommended. */ strictprivileges = yes /* * If set, Services will set the channel modes a user has access to upon identifying, assuming - * they are not already set. This directive is optional. + * they are not already set. + * + * This directive is optional. */ modeonid = yes @@ -1074,14 +1124,16 @@ chanserv nick = "ChanServ" /* - * The description of the ChanServ client, which will be used as the GECOS (real - * name) of the client. + * The description of the ChanServ client, which will be used as the GECOS + * (real name) of the client. */ description = "Channel Registration Service" /* * The core modules to load for ChanServ. This is a space separated list that corresponds - * to the base names of the modules for ChanServ. This directive is optional, but highly recommended. + * to the base names of the modules for ChanServ. + * + * This directive is optional, but highly recommended. */ modules = "cs_help cs_register cs_set cs_saset cs_saset_noexpire cs_set_bantype cs_set_description cs_set_entrymsg cs_set_founder cs_set_keeptopic cs_set_opnotice cs_set_peace cs_set_persist cs_set_private cs_set_restricted cs_set_secure cs_set_securefounder cs_set_secureops cs_set_signkick cs_set_successor cs_set_topiclock cs_set_xop cs_xop cs_access cs_akick cs_drop cs_ban cs_clearusers cs_modes cs_getkey cs_invite cs_kick cs_list cs_topic cs_info cs_forbid cs_suspend cs_status cs_unban cs_clone cs_mode" @@ -1108,6 +1160,7 @@ chanserv * - topiclock: Disallow the topic to be changed except with ChanServ's TOPIC command * - xop: Enable use of the xOP system * - persist: Keep the channel open at all times + * - none: No defaults * * This directive is optional, if left blank, the options will default to keetopic, secure, securefounder, * and signkick. If you really want no defaults, use "none" by itself as the option. @@ -1115,27 +1168,34 @@ chanserv defaults="keeptopic peace secure securefounder signkick xop" /* - * The maximum number of channels which may be registered to a single nickname. This directive is optional, - * but recommended. If not set, there will be no restriction on the numbers of channels a single nickname - * can have registered. + * The maximum number of channels which may be registered to a single nickname. + * + * This directive is optional, but recommended. + * If not set, there will be no restriction on the numbers of channels a single nickname can have registered. */ maxregistered = 20 /* - * The length of time before a channel registration expires. This directive is optional, but - * recommended. If not set, the default is 14 days. + * The length of time before a channel registration expires. + * + * This directive is optional, but recommended. + * If not set, the default is 14 days. */ expire = 14d /* - * The length of time before a suspended channel becomes unsuspended. This directive is optional. + * The length of time before a suspended channel becomes unsuspended. + * + * This directive is optional. * If not set, the default is to never. */ #suspendexpire = 90d /* - * The lenth of time before a forbidden channel drops. This directive is optional. If not set, the - * default is to never. + * The lenth of time before a forbidden channel drops. + * + * This directive is optional. + * If not set, the default is to never. */ #forbidexpire = 90d @@ -1173,7 +1233,9 @@ chanserv inhabit = 15s /* - * Limits the use of the ChanServ LIST command to IRC operators. This directive is optional. + * Limits the use of the ChanServ LIST command to IRC operators. + * + * This directive is optional. */ #listopersonly = yes @@ -1183,7 +1245,9 @@ chanserv listmax = 50 /* - * Allow only IRC Operators to use ChanServ. This directive is optional. + * Allow only IRC Operators to use ChanServ. + * + * This directive is optional. */ #opersonly = yes } @@ -1202,21 +1266,25 @@ memoserv nick = "MemoServ" /* - * The description of the MemoServ client, which will be used as the GECOS (real - * name) of the client. + * The description of the MemoServ client, which will be used as the GECOS + * (real name) of the client. */ description = "Memo Service" /* * The core modules to load for MemoServ. This is a space separated list that corresponds - * to the base names of the modules for MemoServ. This directive is optional, but highly recommended. + * to the base names of the modules for MemoServ. + * + * This directive is optional, but highly recommended. */ modules = "ms_send ms_cancel ms_list ms_read ms_del ms_set ms_info ms_rsend ms_check ms_staff ms_sendall ms_ignore ms_help" /* * The maximum number of memos a user is allowed to keep by default. Normal users may set the * limit anywhere between 0 and this value. Services Admins can change it to any value or - * disable it. This directive is optional, but recommended. If not set, the limit is disabled + * disable it. + * + * This directive is optional, but recommended. If not set, the limit is disabled * by default, and normal users can set any limit they want. */ maxmemos = 20 @@ -1225,15 +1293,18 @@ memoserv * The delay between consecutive uses of the MemoServ SEND command. This can help prevent spam * as well as denial-of-service attacks from sending large numbers of memos and filling up disk * space (and memory). The default 3-second wait means a maximum average of 150 bytes of memo - * per second per user under the current IRC protocol. This directive is optional, but - * recommended. + * per second per user under the current IRC protocol. + * + * This directive is optional, but recommended. */ senddelay = 3s /* * Should we notify all appropriate users of a new memo? This applies in cases where a memo is * sent to a nick which is in the group of another nick. Note that, unlike before, it is currently - * more efficient to enable this. This directive is optional. + * more efficient to enable this. + * + * This directive is optional. */ notifyall = yes @@ -1263,14 +1334,16 @@ botserv nick = "BotServ" /* - * The description of the BotServ client, which will be used as the GECOS (real - * name) of the client. + * The description of the BotServ client, which will be used as the GECOS + * (real name) of the client. */ description = "Bot Service" /* * The core modules to load for BotServ. This is a space separated list that corresponds - * to the base names of the modules for BotServ. This directive is optional, but highly recommended. + * to the base names of the modules for BotServ. + * + * This directive is optional, but highly recommended. */ modules = "bs_help bs_botlist bs_assign bs_set bs_kick bs_badwords bs_act bs_info bs_say bs_unassign bs_bot" @@ -1317,19 +1390,24 @@ botserv * But some people may want to make it act like a real bot, that is, for example, remove all * the bans affecting the bot before joining the channel, remove a ban that affects the bot * set by an user when it is in the channel, and so on. Since it consumes a bit more CPU - * time, you should not enable this on larger networks. This directive is optional. + * time, you should not enable this on larger networks. + * + * This directive is optional. */ #smartjoin = yes /* * If set, the bots will use a kick reason that does not state the word when it is kicking. - * This is especially useful if you have young people on your network. This directive is - * optional. + * This is especially useful if you have young people on your network. + * + * This directive is optional. */ gentlebadwordreason = yes /* - * If set, BotServ will use case sensitive checking for badwords. This directive is optional. + * If set, BotServ will use case sensitive checking for badwords. + * + * This directive is optional. */ #casesensitive = yes @@ -1344,9 +1422,11 @@ botserv /* * [OPTIONAL] HostServ Config * - * This section is used to set up the vHost Service pseudo-client. The block is optional and can be - * removed if you do not wish to have HostServ on your network. Unless specified otherwise, - * all directives are required if you do wish to use HostServ. + * This section is used to set up the vHost Service pseudo-client. + * + * The block is optional and can be removed if you do not wish to have HostServ on your network. + * + * Unless specified otherwise, all directives are required if you do wish to use HostServ. */ hostserv { @@ -1356,14 +1436,16 @@ hostserv nick = "HostServ" /* - * The description of the HostServ client, which will be used as the GECOS (real - * name) of the client. + * The description of the HostServ client, which will be used as the GECOS + * (real name) of the client. */ description = "vHost Service" /* * The core modules to load for HostServ. This is a space separated list that corresponds - * to the base names of the modules for HostServ. This directive is optional, but highly recommended. + * to the base names of the modules for HostServ. + * + * This directive is optional, but highly recommended. */ modules = "hs_help hs_on hs_off hs_group hs_list hs_set hs_setall hs_del hs_delall" } @@ -1382,21 +1464,25 @@ operserv nick = "OperServ" /* - * The description of the OperServ client, which will be used as the GECOS (real - * name) of the client. + * The description of the OperServ client, which will be used as the GECOS + * (real name) of the client. */ description = "Operator Service" /* * The core modules to load for OperServ. This is a space separated list that corresponds - * to the base names of the modules for OperServ. This directive is optional, but highly recommended. + * to the base names of the modules for OperServ. + * + * This directive is optional, but highly recommended. */ modules = "os_help os_global os_stats os_staff os_mode os_kick os_akill os_snline os_sqline os_szline os_chanlist os_userlist os_news os_session os_noop os_jupe os_ignore os_set os_reload os_update os_restart os_quit os_shutdown os_defcon os_chankill os_svsnick os_oline os_umode os_modload os_modunload os_modreload os_modlist os_modinfo" /* * If set, Services Admins will be able to use SUPERADMIN [ON|OFF] which will temporarily grant - * them extra privileges, such as being a founder on ALL channels, ability to adjust another - * users' modes, etc. This directive is optional. + * them extra privileges such as being a founder on ALL channels, ability to adjust another + * users' modes, etc. + * + * This directive is optional. */ #superadmin = yes @@ -1413,21 +1499,25 @@ operserv /* * If set, this option will make Services send an AKILL command immediately after it has been * added with AKILL ADD. This eliminates the need for killing the user after the AKILL has - * been added. This directive is optional. + * been added. + * + * This directive is optional, but recommended. */ - #akillonadd = yes + akillonadd = yes /* * If set, this option will make Services send an (SVS)KILL command immediately after SNLINE ADD. - * This eliminates the need for killingthe user after the SNLINE has been added. This directive - * is optional. + * This eliminates the need for killingthe user after the SNLINE has been added. + * + *This directive is optional. */ #killonsnline = yes /* * If set, this option will make Services send an (SVS)KILL command immediately after SQLINE ADD. - * This eliminates the need for killingthe user after the SQLINE has been added. This directive - * is optional. + * This eliminates the need for killingthe user after the SQLINE has been added. + * + * This directive is optional. */ #killonsqline = yes @@ -1480,63 +1570,74 @@ operserv /* * Default session limit per host. Once a host reaches it's session limit, all clients attempting * to connect from that host will be killed. A value of zero means an unlimited session limit. + * + * This directive is optional. * If not given and session limiting is enabled, it will default to no limit. */ defaultsessionlimit = 3 /* - * The maximum session limit that may be set for a host in an exception. This directive is only - * required if session limiting is enabled. + * The maximum session limit that may be set for a host in an exception. + * + * This directive is only required if session limiting is enabled. */ maxsessionlimit = 100 /* - * Sets the default expiry time for session exceptions. This directive is only required if session - * limiting is enabled. + * Sets the default expiry time for session exceptions. + * + * This directive is only required if session limiting is enabled. */ exceptionexpiry = 1d /* * The message that will be NOTICE'd to a user just before they are removed from the network because * their host's session limit has been exceeded. It may be used to give a slightly more descriptive - * reason for the impending kill as opposed to simply "Session limit exceeded". This directive is - * optional, if not set, nothing will be sent. + * reason for the impending kill as opposed to simply "Session limit exceeded". + * + * This directive is optional, if not set, nothing will be sent. */ sessionlimitexceeded = "The session limit for your host %s has been exceeded." /* * Same as above, but should be used to provide a website address where users can find out more - * about session limits and how to go about applying for an exception. This directive is optional, - * if not set, nothing will be sent. + * about session limits and how to go about applying for an exception. * * Note: This directive has been intentionally commented out in an effort to remind you to change * the URL it contains. It is recommended that you supply an address/URL where people can get help * regarding session limits. + * + * This directive is optional, if not set, nothing will be sent. */ #sessionlimitdetailsloc = "Please visit http://your.website.url/ for more information about session limits." /* * If set and is not 0, this directive tells Services to add an AKILL the number of subsequent kills - * for the same host exceeds this value, preventing the network from experiencing KILL floods. This - * directive is optional. + * for the same host exceeds this value, preventing the network from experiencing KILL floods. + * + * This directive is optional. */ maxsessionkill = 15 /* - * Sets the expiry time for AKILLs set for hosts exceeding the maxsessionkill directive limit. This - * directive is optional, if not set, defaults to 30 minutes. + * Sets the expiry time for AKILLs set for hosts exceeding the maxsessionkill directive limit. + * + * This directive is optional, if not set, defaults to 30 minutes. */ sessionautokillexpiry = 30m /* - * Adds the nickname of the IRC Operator issuing an AKILL to the kill reason. This directive is - * optional. + * Adds the nickname of the IRC Operator issuing an AKILL to the kill reason. + * + * This directive is optional. */ addakiller = yes /* * If set, only IRC Operators will be permitted to use OperServ, regardless of module-based command - * access restrictions. This directive is optional, but recommended. + * access restrictions. + * + * This directive is optional, but recommended. */ opersonly = yes } @@ -1558,8 +1659,8 @@ global nick = "Global" /* - * The description of the Global client, which will be used as the GECOS (real - * name) of the client. + * The description of the Global client, which will be used as the GECOS + * (real name) of the client. */ description = "Global Noticer" } @@ -1620,30 +1721,37 @@ defcon * is +RN when DefCon is used, all channels will be set to +RN, when DefCon is removed, all * channels will be set to -RN. You don't want to set this to +k for example, because when DefCon * is removed all channels with -k. - * Note 2: MLOCK'd modes will not be lost. + * + * Note 2: MLOCKed modes will not be lost. */ #chanmodes = "+R" /* * This value can be used to automatically return the network to DefCon level 5 after the specified - * time period, just in case any IRC Operator forgets to remove a DefCon setting. This directive is - * optional. + * time period, just in case any IRC Operator forgets to remove a DefCon setting. + * + * This directive is optional. */ #timeout = 15m /* - * If set, Services will send a global message on DefCon level changes. This directive is optional. + * If set, Services will send a global message on DefCon level changes. + * + * This directive is optional. */ #globalondefcon = yes /* * If set, Services will send the global message defined in the message directive on DefCon level - * changes. This directive is optional. + * changes. + * + * This directive is optional. */ #globalondefconmore = yes /* * Defines the message that will be sent on DefCon level changes when globalondefconmore is set. + * * This directive is required only when globalondefconmore is set. */ #message = "Put your message to send your users here. Dont forget to uncomment globalondefconmore" @@ -1769,7 +1877,9 @@ m_helpchan { /* * For the given channel, every user that has or gets op status of the channel - * will automatically receive the +h user mode. This directive is optional. + * will automatically receive the +h user mode. + * + * This directive is optional. */ helpchannel = "#help" } @@ -1805,13 +1915,13 @@ m_dnsbl /* * If set, Services will check clients against the DNSBLs when services connect to its uplink. * This is not recommended, and on large networks will open a very large amount of DNS queries. - * While services are not drastically affected by this, your nameserver/DNSBL might care. + * Whilst services are not drastically affected by this, your nameserver/DNSBL might care. */ check_on_connect = no /* * If set, Services will check clients when coming back from a netsplit. This can cause a large number - * of DNS queries open at once. While services are not drastically affected by this, your nameserver/DNSBL + * of DNS queries open at once. Whilst services are not drastically affected by this, your nameserver/DNSBL * might care. */ check_on_netburst = no