Merge of 9704ccc8a62f...c362a1e077d5

7 files changed, 461 insertions, 726 deletions

diff --git a/data/example.conf b/data/example.conf
index 0b0c1abcd..9e3ba7369 100644
--- a/data/example.conf
+++ b/data/example.conf
@@ -324,8 +324,8 @@ 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.
 	 */
@@ -337,8 +337,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
 
@@ -347,7 +348,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
 
@@ -410,7 +413,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
 
@@ -444,7 +449,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
 
@@ -463,13 +470,25 @@ options
 
 	/*
 	 * If set, Services will hide the IRC operator's nick in a global
+<<<<<<< HEAD
 	 * message/notice. This directive is optional.
+=======
+	 * message/notice.
+	 *
+	 * This directive is optional.
+>>>>>>> 679d3c3... Fixing leftover spaces and other rubbish I missed on the first pass.
 	 */
 	#anonymousglobal = yes
 
 	/*
 	 * Prevents users from registering their nick if they are not connected
+<<<<<<< HEAD
 	 * for at least the given number of seconds. This directive is optional.
+=======
+	 * for at least the given number of seconds.
+	 *
+	 * This directive is optional.
+>>>>>>> 679d3c3... Fixing leftover spaces and other rubbish I missed on the first pass.
 	 */
 	#nickregdelay = 30
 
@@ -477,7 +496,7 @@ 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
@@ -800,8 +819,7 @@ 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.
@@ -810,8 +828,10 @@ mail
 
 	/*
 	 * 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
 }
@@ -860,14 +880,16 @@ nickserv
 
 	/*
 	 * 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"
 
 	/*
-	 * 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
 
@@ -922,27 +944,31 @@ 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 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
 
@@ -965,19 +991,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
 
@@ -994,8 +1026,9 @@ 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
 
@@ -1008,7 +1041,9 @@ nickserv
 
 	/*
 	 * 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
 
@@ -1042,7 +1077,9 @@ chanserv
 
 	/*
 	 * 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_mlock 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_clear cs_modes cs_getkey cs_invite cs_kick cs_list cs_topic cs_info cs_forbid cs_suspend cs_status cs_unban"
 
@@ -1076,15 +1113,18 @@ 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
 
@@ -1122,7 +1162,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
 
@@ -1132,7 +1174,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
 }
@@ -1151,21 +1195,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_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
@@ -1174,15 +1222,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
 
@@ -1212,8 +1263,8 @@ 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"
 
@@ -1272,13 +1323,16 @@ botserv
 
 	/*
 	 * 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
 
@@ -1293,9 +1347,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
 {
@@ -1305,14 +1361,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"
 }
@@ -1338,14 +1396,18 @@ operserv
 
 	/*
 	 * 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_clearmodes 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
 
@@ -1362,21 +1424,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
 
 	/*
 	 * 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
 
@@ -1430,34 +1496,38 @@ 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
@@ -1467,26 +1537,31 @@ operserv
 
 	/*
 	 * 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
 }
@@ -1508,8 +1583,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"
 }
@@ -1576,24 +1651,30 @@ defcon
 
 	/*
 	 * 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"
@@ -1719,7 +1800,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"
 }
diff --git a/docs/BUGS b/docs/BUGS
index 1f640fa5e..4c5bf2de9 100644
--- a/docs/BUGS
+++ b/docs/BUGS
@@ -1,4 +1 @@
-Reported Bugs from Bugzilla: http://bugs.anope.org/
----------------------------------------------------
-
-
+For all bug reports / updates please see http://bugs.anope.org
diff --git a/docs/INSTALL b/docs/INSTALL
index 3883f5a51..28b526251 100644
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -162,7 +162,7 @@ Note: You should also read the README and FAQ files!
 4) Starting Anope
 
     Go into the directory where binaries were installed (by default, this is
-    ~/services). Type ./services to launch Anope.
+    ~/services/bin). Type ./services to launch Anope.
 
     If there are syntax errors in the configuration file they will be
     displayed on the screen. Correct them until there are no errors anymore.
@@ -180,9 +180,7 @@ Note: You should also read the README and FAQ files!
 5) Setting up a crontab
 
     A crontab entry will allow you to check periodically whether Anope is
-    still running, and restart it if not. You'll need to have Anope binaries
-    and data installed in the same directory for this to work without
-    modification.
+    still running, and restart it if not.
 
     First rename the example.chk script that is in Anope path (by default,
     this is ~/services) to services.chk and edit it. You'll need to modify
diff --git a/docs/LANGUAGE b/docs/LANGUAGE
index 0a2831e69..ca3838639 100644
--- a/docs/LANGUAGE
+++ b/docs/LANGUAGE
@@ -27,6 +27,8 @@ Anope Mutli Language Support
     If you have finished a language file translation and you want others to use it, please send it to team@anope.org
     (don't forget to mention clearly your (nick)name, your e-mail and the language name). You'll of course get full credit for it.
 
+    NOTE: There is no guarantee we will use your work so please do not be offended if we say no thanks.
+
 3) Using langages with modules
 
     Module authors can easially add the ability to have their modules translated by adding _() around the strings they
diff --git a/docs/README b/docs/README
index 787bd27a9..392fec882 100644
--- a/docs/README
+++ b/docs/README
@@ -1,321 +1,285 @@
-Anope -- a set of IRC services for IRC networks

------------------------------------------------

-

-Anope is          2003-2010 Anope Team    <team@anope.org>.

-Based on Epona    2000-2002 PegSoft       <epona@pegsoft.net>.

-Based on Services 1996-1999 Andrew Church <achurch@achurch.org>.

-

-This program is free but copyrighted software; see the file COPYING for

-details.

-

-Information about Anope may be found at http://www.anope.org/

-Information about Epona may be found at http://www.epona.org/

-Information about Services may be found at http://www.ircservices.esper.net/

-

-Table of Contents

------------------

-1) Credits

-2) Presentation

-3) Installation

-4) Command Line Options

-5) Messages Translation

-6) Contact and Mailing List

-

-1) Credits

-

-    Anope is based on Lara's Epona version 1.4.14.

-    Epona is based on Andy Church's IRC Services version 4.3.3.

-

-    The original credits:

-

-        * Mauritz Antunes

-            Portuguese translation

-        * Jose R. Holzmann, Raul S. Villarreal

-            Spanish translation

-        * Andrew Kempe <theshadow@shadowfire.org>

-            News system

-        * <d.duca@eurcom.net>

-            Italian translation

-        * <mikado@holyfire.com>

-            Turkish translation

-        * Andrew Kempe <theshadow@shadowfire.org>

-            Session limiting

-

-    Epona credits:

-

-        * lara <lara@pegsoft.net>

-            Main coding

-        * CafeiN <oytuny@yahoo.com>

-            Turkish translation

-        * Sylvain Cresto aka tost <scresto@netsante.fr>

-            FreeBSD 5 patch

-        * Marcelo Conde Foscarini aka Bras <ircadmin@brmarket.net>

-            Portuguese translation

-        * Alvaro Toledo aka POLLITO <atoledo@keldon.org>

-            Spanish translation

-        * chemical <chemical@musicplay.de>

-            German translation

-        * shine <dh@shinewelt.de>

-            German translation

-        * Guven Guzelbey aka MeShGuL <guzelbey@cs.utk.edu>

-            Turkish translation

-        * Jordi Pujol <jordi.pujol@aujac.org>

-            Catalan translation

-        * Eva Dachs <evadachs@terra.es>

-            Catalan translation

-        * Toni Perez <toni.perez@aujac.org>

-            Catalan translation

-        * Sergios Karalis <sergios_k@hotmail.com>

-            Greek translation

-        * Thomas J. Stensas aka ShadowMaster <shadowmaster@shadow-realm.org>

-            Ultimate 3.x support

-

-    Anope credits:

-

-        * Adam Kramer <ribosome@anope.org>

-        * Adam <adam@anope.org>

-        * Alvaro Toledo <atoledo@keldon.org>

-        * Amanda Folson <amanda@anope.org>

-        * Andrew Berquist <vash@anope.org>

-        * Björn Stiddien <keeper@anope.org>

-        * Charles Kingsley <chaz@anope.org>

-        * Chris Hogben <heinz@anope.org>

-        * Daniel Engel <dane@zero.org>

-        * David <dv@diboo.net>

-        * David Narayan <jester@phrixus.net>

-        * David Robson <rob@anope.org>

-        * Daniele Nicolucci <jollino@sogno.net>

-        * Florian Schulze <certus@anope.org>

-        * Gabriel Acevedo H. <drstein@anope.org>

-        * Jan Milants <viper@anope.org>

-        * Jens Voss <dukepyrolator@anope.org>

-        * JH <jh@irc-chat.net>

-        * Joris Vink <joris@anope.org>

-        * Lucas Nussbaum <lucas@lucas-nussbaum.net>

-        * Mark Summers <mark@goopler.net>

-        * Matthew Beeching <jobe@invictachat.net>

-        * Naram Qashat <cyberbotx@anope.org>

-        * Pieter Bootsma <geniusdex@anope.org>

-        * Robin Burchell <w00t@inspircd.org>

-        * Thomas Juberg Stensås <ShadowMaster@Shadow-Realm.org>

-        * Trystan .S Lee <trystan@nomadirc.net>

-        * openglx <openglx@brasnerd.com.br>

-

-    Anope Translations:

-

-        * GeniusDex <geniusdex@anope.org> (nl.l)

-        * Kein <kein-of@yandex.ru> (ru.l)

-        * Stuff <the.stuff@gmx.de> (de.l)

-        * Gabriel Acevedo H. <drstein@anope.org> (es.l)

-        * Janos Kapitany <sarkanyka@cjbchat.hu>  (hun.l)

-        * Szymon S'wierkosz <szymek@adres.pl> (pl.l)

-

-    Anope uses the strlcat() and strlcpy() functions from OpenSSH 2.5.1p2.

-    These functions are copyrighted by Todd C. Miller:

-

-        Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>

-        All rights reserved.

-

-        Redistribution and use in source and binary forms, with or without

-        modification, are permitted provided that the following conditions

-        are met:

-        1. Redistributions of source code must retain the above copyright

-           notice, this list of conditions and the following disclaimer.

-        2. Redistributions in binary form must reproduce the above copyright

-           notice, this list of conditions and the following disclaimer in the

-           documentation and/or other materials provided with the distribution.

-        3. The name of the author may not be used to endorse or promote

-           products derived from this software without specific prior written

-           permission.

-

-        THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESS OR IMPLIED

-        WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

-        MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

-        IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,

-        INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

-        BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS

-        OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

-        ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR

-        TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE

-        USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

-        SUCH DAMAGE.

-

-

-2) Presentation

-

-    Anope is a set of Services for IRC networks that allows users to manage

-    their nicks and channels in a secure and efficient way, and administrators

-    to manage their network with powerful tools.

-

-    Currently available services are:

-

-        * NickServ, a powerful nickname manager that users can use to protect

-          themselves against nick stealing. Each user has its own nickname

-          group, that allows the user to register as many nicks as needed

-          while still being able to take profit of his privileges and to

-          modify the nick configuration. NickServ also has an optional

-          password retrieval feature.

-

-        * ChanServ, a powerful channel manager that helps users to administer

-          their channels in a totally customizable way. ChanServ has an

-          internal list of privileged users and banned users that controls

-          accesses on a per-channel basis. It eliminates all takeover

-          problems, because of its powerful op/unban/invite and even mass

-          deop and mass kick functions.

-

-        * MemoServ, an helpful companion that allows sending short messages

-          to offline users, that they can then read when they come online

-          later.

-

-        * BotServ, an original service that allows users to get a permanent,

-          friendly bot on their channels in an easy way. Each bot can be

-          configured to monitor the channels against floods, repetitions,

-          caps writing, and swearing, and to take appropriate actions. It

-          also can handle user-friendly commands (like !op, !deop, !voice,

-          !devoice, !kick, and many others), say a short greet message when

-          an user joins a channel, and even "take over" ChanServ actions such

-          as auto-opping users, saying the entry notice, and so on. This

-          service can be disabled if you want to save some bandwidth.

-

-        * OperServ, the IRCops' and IRC admins' black box, that allows them

-          to manage the list of network bans (also known as AKILL (DALnet) or

-          GLINE (Undernet)), to configure messages displayed to users when

-          they log on, to set modes and to kick users from any channel, to

-          send notices quickly to the entire network, and much more!

-

-        * HostServ, a neat service that allows users to show custom vHosts

-          (virtual hosts) instead of their real IP address; this only works

-          on daemons supporting ip cloaking, such as UnrealIRCd, UltimateIRCd

-          and ViagraIRCd.

-

-    Anope currently works with:

-

-        * Bahamut 1.4.27 or later (including 1.8)

-        * InspIRCd 1.1, 1.2, or 2.0

-        * Ratbox 2.0.6 or later

-        * UnrealIRCd 3.2 or later

-

-    Anope could also work with some of the daemons derived by the ones listed

-    above, but there's no support for them if they work or don't work.

-

-

-3) Installation

-

-    See the INSTALL file for instruction on installing Anope.

-

-

-4) Command Line Options

-

-    Normally, Anope can be run simply by invoking the "services" executable.

-    Any of the following command-line options can be specified to change

-    the behavior of Anope:

-

-        --debug         Enable debugging mode; more info sent to log (give

-                            option more times for more info)

-        --readonly      Enable read-only mode; no changes to databases

-                            allowed

-        --nofork        Do not fork after startup; log messages will be

-                            written to terminal

-        --noexpire      Expiration routines won't be run at all

-        --version       Display the version of Anope

-        --nothird       Do not load the non-core modules specified

-        --protocoldebug Debug each incoming message after protocol parsing

-        --support       Used for support, same as -debug -nofork -nothird

-

-    Upon starting, Anope will parse its command-line parameters then

-    (assuming the -nofork option is not given) detach itself and run in the

-    background. If Anope encounters a problem reading the database files or

-    cannot connect to its uplink server, it will terminate immediately;

-    otherwise, it will run until the connection is terminated (or a QUIT,

-    SHUTDOWN, or RESTART command is sent; see OperServ's help).

-

-    In the case of an error, an appropriate error message will be written to

-    the log file.

-

-    If Anope is run with the "--readonly" command-line option, it can serve as

-    a "backup" to the full version of services.  A "full" version of services

-    (run without --readonly) will automatically reintroduce its pseudo-clients

-    (NickServ, ChanServ, etc.), while a "backup" services will not, thus

-    allowing full services to be brought up at any time without disrupting

-    the network (and without having to take backup services down beforehand).

-

-    The "--debug" option is useful if you find or suspect a problem in Anope.

-    Giving it once on the command line will cause all traffic to and from

-    services as well as some other debugging information to be recorded in

-    the log file; if you send a bug