summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles Kingsley <chaz@anope.org>2011-01-29 14:16:09 -0500
committerAdam <Adam@anope.org>2011-01-29 14:16:09 -0500
commitfb0f7649b44f45bec143b2d59b708955d27b137b (patch)
tree6e4972cef874752515a3c448bb3f2fdccce3876b
parent92fb9844ecbcb31ecde4c971eb2d3e601641dc5a (diff)
Merge of 9704ccc8a62f...c362a1e077d5
-rw-r--r--data/example.conf255
-rw-r--r--docs/BUGS5
-rw-r--r--docs/INSTALL6
-rw-r--r--docs/LANGUAGE2
-rw-r--r--docs/README606
-rw-r--r--docs/TOOLS4
-rw-r--r--docs/TROUBLESHOOTING309
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 report, PLEASE include an excerpt from
- the log file WITH DEBUGGING ACTIVE; we cannot emphasize enough how
- important this is to tracking down problems. (You can also enable
- debugging while Services is running using OperServ's SET DEBUG command.)
- If you repeat use --debug=<level>, the debugging level will be increased,
- which provides more detailed information but may also slow Anope down
- considerably and make the log file grow dramatically faster. In general,
- a debug level of 1 is sufficient for the coding team to be able to trace
- a problem, because all network traffic is included and we can usually
- reproduce the problem.
-
-5) Messages Translations
-
- Anope has a powerful option in NickServ allowing users to choose what
- language it must use when sending messages to users. Messages are stored
- in language files (located in the lang directory).
-
- Anope is currently provided with thirteen languages: Catalan, Dutch,
- English, French, German, Greek, Hungarian, Italian, Polish, Portuguese,
- Russian, Spanish and Turkish. If you want to translate Anope messages
- into another language, follow this instructions:
-
- * Copy the lang/en_us.l file to a meaningful name (for example, if
- you would like to translate messages in Spanish, you would rename
- it to es.l).
-
- * Edit the file with your favorite text editor. Carefully read the
- instructions given at the top of the file, and start translating
- the whole file. The file is big, so make sure you have some coffee
- available ;) Try to avoid the use of English words as much as
- possible. If the new language contains only a few 'special'
- characters, try and use latin representations of it, if possible.
- Remember that most clients are only capable of handling the
- ISO-8859-1 charset. Of course, if you are translating Anope to a
- language with a totally different charset, such as Russian, feel
- free to use the one that suites it best (and the one that is in use
- by most speakers of that language ;)).
-
- * When this is done, you have two solutions: either patch Services
- source code so they take in account the new language file
- (basically, you'll have to modify lang/Makefile, language.c and
- maybe services.h), or send us the translated file so we can make
- the patch and include your language in the next Anope release.
-
- * Note that there is a language tool on bin/langtool.pl that can aid
- the verification process on newly created language files. Try to
- use it before you submit a language file.
-
- When new major releases come out, you'll not have to retranslate the
- whole file; the Changes.lang file will help you to know which messages
- were added, modified or deleted.
-
- If you did a language file translation, and want to let others 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, and will even get future final major releases before
- anyone else to complete the translation!... ;)
-
-6) Contact
-
- For announcements and discussions about Anope, please visit our
- Portal and Forums at http://www.anope.org/ -- make sure you register
- yourself and your network to get full benefits.
-
- If you read the documentation carefully, and didn't find the answer to
- your question, feel free to post on the website forums or join our irc
- channel (irc.anope.org #anope). Once you join our Support channel, just
- type "? report" for instructions on how to report a Bug. Be as precise as
- possible when asking a question, because we have no extraordinary powers
- and can't guess things if they aren't provided. The more precise you are,
- the sooner you'll be likely to get an answer.
-
- If you think you found a bug, add it to the bug tracking system
- (http://bugs.anope.org) and - again - be as precise as possible. Also say
- whether the bug happens always or under what circumstances, and anything
- that could be useful to track your bug down. If you wrote a patch, send
- it over. :)
+Anope -- a set of IRC services for IRC networks
+-----------------------------------------------
+
+Anope is 2003-2011 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>
+ * Lee Holmes <lethality@anope.org>
+ * Lucas Nussbaum <lucas@lucas-nussbaum.net>
+ * Mark Summers <mark@goopler.net>
+ * Matthew Beeching <jobe@invictachat.net>
+ * Naram Qashat <cyberbotx@anope.org>
+ * Phil Lavin <phil@anope.org>
+ * Pieter Bootsma <geniusdex@anope.org>
+ * Robin Burchell <w00t@inspircd.org>
+ * Sean Roe <therock247uk@anope.org>
+ * Sebastian V <hal9000@anope.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)
+ * Maik Funke <Han@mefalcon.org> (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)
+ * Christopher N. <saka@epiknet.org> (fr.l)
+ * Yusuf Kurekci <ysfm.20@gmail.com> (tr.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.
+
+ 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
+ * Plexus 3 or later
+ * ngIRCd 17.1 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 report, PLEASE include an excerpt from
+ the log file WITH DEBUGGING ACTIVE; we cannot emphasize enough how
+ important this is to tracking down problems. (You can also enable
+ debugging while Services is running using OperServ's SET DEBUG command.)
+ If you repeat use --debug=<level>, the debugging level will be increased,
+ which provides more detailed information but may also slow Anope down
+ considerably and make the log file grow dramatically faster. In general,
+ a debug level of 1 is sufficient for the coding team to be able to trace
+ a problem, because all network traffic is included and we can usually
+ reproduce the problem.
+
+5) Messages Translations
+
+ Please see LANGUAGE for this information
+
+6) Contact
+
+ For announcements and discussions about Anope, please visit our
+ Portal and Forums at http://www.anope.org/ -- make sure you register
+ yourself to get full benefits.
+
+ If you read the documentation carefully, and didn't find the answer to
+ your question, feel free to post on the website forums or join our irc
+ channel (irc.anope.org #anope). Once you join our Support channel be as
+ precise as possible when asking a question, because we have no extraordinary
+ powers and can't guess things if they aren't provided.
+
+ The more precise you are the sooner you'll be likely to get an answer.
+
+ If you think you found a bug, add it to the bug tracking system
+ (http://bugs.anope.org) and - again - be as precise as possible. Also say
+ whether the bug happens always or under what circumstances, and anything
+ that could be useful to track your bug down. If you wrote a patch, send
+ it over. :)
diff --git a/docs/TOOLS b/docs/TOOLS
index 0771f0671..d33d142de 100644
--- a/docs/TOOLS
+++ b/docs/TOOLS
@@ -10,10 +10,10 @@ Anope Bundled Tools
options. To use the SMTP client instead of sendmail, find the line in your
services configuration file (services.conf) that defines sendmailpath. On
that line, change the path to your services installation directory, then
- followed by "tools/anopesmtp" and the IP address of a valid SMTP server. It
+ followed by "bin/anopesmtp" and the IP address of a valid SMTP server. It
should look like this:
- sendmailpath = "/home/anope/services/tools/anopesmtp 127.0.0.1"
+ sendmailpath = "/home/anope/services/bin/anopesmtp 127.0.0.1"
If the SMTP client doesn't send mail, or if there's an other problem with
it, you can compile it in debug mode. To do this, open anopesmtp.cpp, and look
diff --git a/docs/TROUBLESHOOTING b/docs/TROUBLESHOOTING
deleted file mode 100644
index 7220f18d4..000000000
--- a/docs/TROUBLESHOOTING
+++ /dev/null
@@ -1,309 +0,0 @@
-Troubleshooting Guide for Anope 1.9
-------------------------------------------------
-
-NOTE:
-An updated version of this guide can be found on our wiki:
-
-http://wiki.anope.org/index.php/Troubleshooting
-
-Table of Contents
------------------
-
-1) General
- 1.1) Anope complains in the logfile about being unable to load the default
- language.
- 1.2) Anope spricht kein Deutsch!, etc. (Anope doesn't speak my language!)
- 1.3) I selected a language other than English, but sometimes Anope sends
- responses in English instead.
- 1.4) Anope always dies after about five minutes, saying "FATAL ERROR! Can't
- back up nick.db".
- 1.5) Anope crashed with a segmentation fault.
- 1.6) I've found a bug that's not mentioned here or in the README or BUGS
- files. What should I do?
- 1.7) My FreeBSD box complains about 'Shared object "nss_dns.so.1" not
- found'
- 1.8) Anope and long (more then 30 character) nicknames.
-
-2) Installation / Configuration
- 2.1) When I run "make", I get an error message like "missing separator",
- "Unassociated shell command", "Unexpected end of line seen", etc.
- 2.2) I get an error like "Makefile.inc not found".
- 2.3) I typed "./services" at the command line, but nothing happened!
- 2.4) Whenever I start Anope, I get a message on my IRC server saying
- "connection refused" or something similar, and Anope gives an error
- message from the server saying "Closing Link: ...".
- 2.5) My IRC server is giving me messages like "Connection to
- services.whatever.net[127.0.0.1] activated" and then "Access denied --
- no N line". Why?
- 2.6) When I say "/connect services.*", it doesn't work!
- 2.7) Anope starts up okay, but if I try to register a nickname, it comes
- back with "Sorry, registration failed."
- 2.8) Anope reports (via /stats u or /msg OperServ STATS) a different number
- of users online than I get from doing /lusers.
-
-3) BotServ
- 3.1) How do I add bots to BotServ?
- 3.2) Why do kick triggers and fantasy commands fail to work with my Bahamut
- IRCd?
-
-4) ChanServ
- 4.1) Anope's channel mode setting doesn't work. I can't set modes with
- OperServ, and every time ChanServ tries to set a mode, my server
- reverses the change.
- 4.2) Anope ignored the SET SUCCESSOR setting and deleted a channel when the
- founder expired.
- 4.3) How to auto voice all those whom join my #channel?
- 4.4) Channel options like RESTRICTED or SECUREOPS don't work. What's wrong?
-
-5) OperServ
- 5.1) Using the OperServ JUPE command results in server messages like
- "Server juped.server introduced by non-hub server services.my.net".
- 5.2) When I add an AKILL, the users matching it don't get killed.
- 5.3) Trying to use OperServ gives me "Access denied".
- 5.4) I can't get /OS UMODES and /OS SVSNICK to work!
- 5.5) What is a Super-Admin? How does it work? Why might it not work?
-
--------------------------------------------------------------------------------
-
-1) General
-
-1.1) Anope complains in the logfile about being unable to load the default
- language.
-
- You forgot to run "make install".
-
-1.2) Anope spricht kein Deutsch!, etc. (Anope doesn't speak my language!)
-
- See section 5 of the README file.
-
-1.3) I selected a language other than English, but sometimes Anope sends
- responses in English instead.
-
- Some language files are not complete--in other words, they only have a
- translation of some of the message Anope uses. In this case, the
- missing messages will be displayed in English. You can either wait for
- the primary translator to provide us with a translation, or do the
- translation yourself and send us the messages translated into your
- language.
-
-1.4) Anope always dies after about five minutes, saying "FATAL ERROR! Can't
- back up nick.db".
-
- Make sure that the user Anope runs as has write access to the data
- directory, and that the data directory actually exists (the latter
- shouldn't be a problem if you ran the Config script). This means Anope
- needs write and execute permission on the data directory itself and execute
- permission on every parent directory of the data directory.
-
-1.5) Anope crashed with a segmentation fault.
-
- See if you can reproduce this by doing a certain sequence of things. If
- so, please report it to us (see part 6 of README file). If not, you're
- probably out of luck; if you like, you can report it to us anyway, but
- chances are it won't get fixed if we don't have instructions on reproducing
- it. If you do have such a problem, you may find the crontab utility useful
- for dealing with it.
-
- Also, see the DumpCore directive in the configuration file. It allows Anope
- to dump its core whenever it's segfaulting, usually calling it core and
- placing it into Anope's main directory. Open up gdb by issuing the
- following command at your shell:
-
- * gdb services core
-
- (of course replacing 'core' with the name of the core if different) and
- type 'bt' at the gdb prompt. After that, send us the output you got and
- keep the core file in a safe place, in case we need it to dig deeper into
- the problem.
-
-1.6) I've found a bug that's not mentioned here or in the README or BUGS files.
- What should I do?
-
- See section 6 of the README file.
-
-1.7) My FreeBSD box complains about 'Shared object "nss_dns.so.1" not found'
-
- We haven't figured out the exact cause yet, but as a quickfix you can
- delete the /etc/nsswitch.conf file. Please keep in mind that removing a
- configuration file can be dangerous, so only do this if you know what you
- are doing.
-
-1.8) Anope and long (more then 30 character) nicknames.
-
- By default, Anope only supports nicknames up to 30 characters (NICKLEN=30).
- If your IRCd allows for longer nicknames or has been modified to do so
- Anope will start logging a lot of ("NICK from nonexistent nick") messages.
- This is because once a user uses a nick that is too long for Anope to handle,
- Anope loses track of the user for the remainder of the session.
- It is POSSIBLE but not NOT RECOMMENDED to extend the maximum length of nicknames
- Anope can track, however this will also break database compatibility. DBs saved
- with Anope set to allow for example 40 chars cannot be read by a clean Anope
- installation and vice versa. So changing the maximum nick length is only possible
- when starting with fresh databases and even then the consequences of this are
- UNTESTED.
- In order to change the maximum internal nick length, change the NICKMAX setting
- in include/config.h, recompile anope and start without databases.
-
-
-2) Installation / Configuration
-
-2.1) When I run "make", I get an error message like "missing separator",
- "Unassociated shell command", "Unexpected end of line seen", etc.
-
- Your make program isn't compatible with the Makefile for Anope. The
- Makefile was designed to work with GNU make, and as such may not work on
- other systems' "make" programs. If you get an error from "make", obtain
- GNU make from ftp://prep.ai.mit.edu/pub/gnu/make/ (or wherever you prefer) and
- use it instead of your system's default "make". Note that GNU make may
- already be installed on your system; try using the command "gmake" instead
- of "make".
-
- The make programs bundled with SunOS/Solaris and FreeBSD have been reported
- not to work; you will need to use GNU make on these systems.
-
-2.2) I get an error like "Makefile.inc not found".
-
- You forgot to run the Config script first. See the INSTALL file for
- compilation instructions.
-
-2.3) I typed "./services" at the command line, but nothing happened!
-
- Anope puts itself in the background when it starts, so you get your shell
- prompt right back. Meanwhile, Anope will continue setting up, then connect
- to the IRC server specified in services.conf (or on the command line). If
- it doesn't connect, you probably specified the wrong IRCd or RemoteServer in
- the configuration file. Check to make sure that you are actually running one of
- the supported IRCds, also. A list of supported IRCds can be found in the README
- file.
-
- You can also check the log file (services.log by default) for error
- messages. Starting services with the -support command line option
- will prevent it from running in the background will output the
- messages written to the log file to the console as well. Please note that this
- will also prevent 3rd party modules from loading and will put Anope into
- debug mode.
-
-2.4) Whenever I start Anope, I get a message on my IRC server saying
- "connection refused" or something similar, and Anope gives an error
- message from the server saying "Closing Link: ...".
-
- See section 3 of the INSTALL file.
-
-2.5) My IRC server is giving me messages like "Connection to
- services.whatever.net[127.0.0.1] activated" and then "Access denied -- no
- N line". Why?
-
- This is typically caused by including a port number in the C:line for
- services, which tells your server to try to autoconnect to it (depending on
- the class (Y:line) settings). This is not what you want, because Anope
- will connect to the server itself, but does not listen for servers to
- connect to it. The solution is to remove the port number from the C:line.
-
-2.6) When I say "/connect services.*", it doesn't work!
-
- You cannot /connect services. When you start Anope, it will attempt to
- connect to the server you specified in services.conf. Please see the answer
- above for more information.
-
-2.7) Anope starts up okay, but if I try to register a nickname, it comes back
- with "Sorry, registration failed."
-
- Make sure you've selected the correct IRC server type in the configure
- script; see section 3 of the INSTALL file for details.
-
-2.8) Anope reports (via /stats u or /msg OperServ STATS) a different number of
- users online than I get from doing /lusers.
-
- Anope doesn't count its own pseudo-clients (NickServ, ChanServ, etc.) in
- its user count, while the IRC server does.
-
-3) BotServ
-
-3.1) How do I add bots to BotServ?
-
- Read /msg BotServ HELP and /msg BotServ HELP BOT. Note that you need to be
- opered up and identified as a Services Administrator in Anope before you
- can use the BOT command.
-
-3.2) Why do kick triggers and fantasy commands fail to work with my Bahamut
- IRCd?
-
- Bahamut allows you to setup a server as 'serviceshub'. This will filter
- certain data that services usually don't need to process. This option also
- filters channel messages, because DALnet's services have no use for them.
- Anope parses the channel messages for kick triggers and fantasy commands.
- To make sure these work the server type of the hub they're linked to should
- be simply 'hub' and not 'serviceshub'.
-
-
-4) ChanServ
-
-4.1) Anope's channel mode setting doesn't work. I can't set modes with
- OperServ, and every time ChanServ tries to set a mode, my server reverses
- the change.
-
- Make sure EVERY server on your network has a U: line for Services in
- ircd.conf, for example:
-
- U:services.whatever.net:*:*
-
-4.2) Anope ignored the SET SUCCESSOR setting and deleted a channel when the
- founder expired.
-
- Normally, this is because the successor had too many channels registered.
- In this case, you will see an entry in the log file like the following:
-
- [date] Successor (SuccessorNick) of channel #somechannel owns too many
- channels, deleting channel #somechannel
-
- If you don't get a message like this or you can verify that the successor
- wasn't running into the channel limit, please report it using the
- bug-reporting procedure in section 6 of the README file.
-
-4.3) How to auto voice all those whom join my #channel?
-
- Execute the following commands (/cs is an alias for /msg ChanServ):
-
- /cs set #channel secure off
- /cs set #channel xop off
- /cs levels #channel set AUTOVOICE -1
-
-4.4) Channel options like RESTRICTED or SECUREOPS don't work. What's wrong?
-
- Make sure that you didn't put any of your normal IRCd's as a ULined server
- in Anope. Some access checks for clients from ULined servers are skipped to
- avoid fights between the ULined servers. This is usually only useful when
- you have a statistics server connected to your network.
-
-5) OperServ
-
-5.1) Using the OperServ JUPE command results in server messages like "Server
- juped.server introduced by non-hub server services.my.net".
-
- Services' uplink must have an H: line for Services in the ircd.conf file,
- which looks something like:
-
- H:*::services.whatever.net
-
-5.2) When I add an AKILL, the users matching it don't get killed.
-
- Use the AkillOnAdd configuration directive.
-
-5.3) Trying to use OperServ gives me "Access denied".
-
- Check that you're opered on your IRCd (ie, moded +o)
- Check that you're identified to a nickname listed within an opertype allowed to do the command you're trying.
- Check whether you can use /msg operserv staff
-
-5.4) I can't get /OS UMODES and /OS SVSNICK to work!
-
- You need to be a SuperAdmin to be able to use these commands.
-
-5.5) What is a Super-Admin? How does it work? Why might it not work?
-
- SuperAdmin's have extra privileges, including being founder on all
- channels. It must be activated on a per user basis and is only available to
- Services Roots. It is set using OperServ and is not persistent. It only
- works if SuperAdmin is not commented in the services configuration file,
- which is commented out by default. Read /msg OperServ HELP SET SUPERADMIN
- for further help.