Merge commit 'cbx/anopeng-config' into anopeng-config

git-svn-id: http://anope.svn.sourceforge.net/svnroot/anope/trunk@1429 5417fbe8-f217-4b02-8779-1006273d7864

2 files changed, 176 insertions, 3 deletions

diff --git a/data/example.conf b/data/example.conf
index 2c494fa4a..b6cd27bb9 100644
--- a/data/example.conf
+++ b/data/example.conf
@@ -1274,9 +1274,6 @@ WallDrop
 #     with a large exception list, can degrade services' performance.
 #     See the source and comments in sessions.c and the online help for more
 #     information about session limiting.
-#
-#     NOTE:  This option is not available when STREAMLINED is defined in
-#     the Makefile.
 
 LimitSessions
 
diff --git a/data/example_new.conf b/data/example_new.conf
index 333b651b7..bca494c00 100644
--- a/data/example_new.conf
+++ b/data/example_new.conf
@@ -123,6 +123,7 @@ uplink
  * [REQUIRED] NickServ Config
  *
  * This section is used to set up the Nickname Registration Service pseudo-client.
+ * Unless specified otherwise, all directives are required.
  */
 nickserv
 {
@@ -130,9 +131,184 @@ nickserv
 	 * The nickname of the NickServ client.
 	 */
 	nick = "NickServ"
+
 	/*
 	 * The description of the NickServ client, which will be used as the GECOS (real
 	 * name) of the client.
 	 */
 	description = "Nickname Registration Service"
+
+	/*
+	 * The filename of the NickServ database.  The path is relative to the services
+	 * executable.  If not given, defaults to "nick.db".
+	 */
+	database = "nick.db"
+
+	/*
+	 * The filename of the NickServ Pre-Nick database.  The path is relative to the
+	 * services executable.  This directive is only required if the e-mail registration
+	 * option is enabled.
+	 */
+	#prenickdatabase = "prenick.db"
+
+	/*
+	 * 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.
+	 */
+	forceemail = yes
+
+	/*
+	 * Require an e-mail to be sent to the user before they can register their nick.
+	 */
+	#emailregistration = yes
+
+	/*
+	 * The default options for newly registered nicks. Note that changing these options
+	 * will have no effect on nicks which are already registered. The list must be separated
+	 * by spaces
+	 *
+	 * The options are:
+	 * -         kill: Kill nick if not identified within 60 seconds
+	 * -    killquick: Kill nick if not identified within 20 seconds, this one overrides the above
+	 *                   option and the above must be specified with this one
+	 * -       secure: Enable nickname security, requiring the nick's password before any operations
+	 *                   can be done on it
+	 * -      private: Hide the nick from NickServ's LIST command
+	 * -    hideemail: Hide's the nick's e-mail address from NickServ's INFO command
+	 * - hideusermask: Hide's the nick's last or current user@host from NickServ's INFO command
+	 * -     hidequit: Hide's the nick's last quit message
+	 * -   memosignon: Notify user if they have a new memo when they sign into the nick
+	 * -  memoreceive: Notify user if they have a new memo as soon as it's received
+	 * -       autoop: User will be automatically opped in channels they enter and have access to
+	 * -          msg: Services messages will be sent as PRIVMSGs instead of NOTICEs, requires UsePrivmsg
+	 *                   to be enabled as well
+	 *
+	 * This directive is optional, if left blank, the options will default to secure, memosignon, and
+	 * memoreceive. If you really want no defaults, use "none" by itself as the option.
+	 */
+	defaults="secure private hideemail hideusermask memosignon memoreceive autoop"
+
+	/*
+	 * Default language that non- and newly-registered nicks will receive messages in. The number
+	 * here is the same as the number in NickServ's SET LANGUAGE help.
+	 */
+	defaultlanguage = 1
+
+	/*
+	 * The minimum length of time between consecutive uses of NickServ's REGISTER command. This
+	 * directive is optional, but recommended. If not set, this restriction will be disabled.
+	 */
+	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.
+	 */
+	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.
+	 */
+	expire = 21d
+
+	/*
+	 * 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.
+	 */
+	#preregexpire = 1d
+
+	/*
+	 * The maximum number of nicks allowed in a group. This directve is optional, but
+	 * recommended. If not set or set to 0, no limits will be applied.
+	 */
+	maxaliases = 16
+
+	/*
+	 * The maximum number of entries allowed on a nickname's access list.
+	 */
+	accessmax = 32
+
+	/*
+	 * The username (and possibly hostname) used for the fake user created when NickServ collides
+	 * 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"
+
+	/*
+	 * The delay before a NickServ-collided nick is released.
+	 */
+	releasetimeout = 1m
+
+	/*
+	 * 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.
+	 */
+	#nogroupchange = yes
+
+	/*
+	 * Limits the use of the NickServ LIST command to IRC operators. This directive is optional.
+	 */
+	#listopersonly = yes
+
+	/*
+	 * The maximum number of nicks to be returned for a NickServ LIST command.
+	 */
+	listmax = 50
+
+	/*
+	 * When a user's nick is forcibly changed to enforce a "nick kill", their new nick will start
+	 * with this value. The rest will be made up of 6 or 7 digits.
+	 */
+	guestnickprefix = "Guest"
+
+	/*
+	 * 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.
+	 */
+	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.
+	 */
+	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.
+	 */
+	#modeonid = yes
+
+	/*
+	 * If set, Services will only allow Services Root(s) to use the NickServ GETPASS command on
+	 * a nick. This directive is optional.
+	 */
+	restrictgetpass = yes
+
+	/*
+	 * If set, Services will track your last nick identified when issuing nick changes. This
+	 * directive is optional.
+	 */
+	#nicktracking = yes
+
+	/*
+	 * If set, Services will add the usermask of registering users to the access list of their
+	 * newly created account. If not set, users will always have to identify to NickServ before
+	 * being recognized, unless they manually add an address to the access list of their account.
+	 * This directive is optional.
+	 */
+	addaccessonreg = yes
 }