diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/BUGS | 5 | ||||
| -rw-r--r-- | docs/INSTALL | 6 | ||||
| -rw-r--r-- | docs/LANGUAGE | 2 | ||||
| -rw-r--r-- | docs/README | 606 | ||||
| -rw-r--r-- | docs/TOOLS | 4 | ||||
| -rw-r--r-- | docs/TROUBLESHOOTING | 309 |
6 files changed, 292 insertions, 640 deletions
@@ -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 - |