diff --git a/data/example.conf b/data/example.conf index d9bff8ce5..e5434bfe8 100644 --- a/data/example.conf +++ b/data/example.conf @@ -280,9 +280,9 @@ options * * The db_mysql_live module is an extension to db_mysql, and should only be used if * db_mysql is being used. This module pulls data in real time from SQL as it is - * requested by the core as a result of someone executing commands. + * requested by the core as a result of someone executing commands. * - * This effectively allows you to edit your database and have it be immediately + * This effectively allows you to edit your database and have it be immediately * reflected back in Anope. * * It is highly recommended you only use this module if your databases are located @@ -343,7 +343,7 @@ 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 name) with which it is associated. When set, however, + * 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. @@ -358,7 +358,7 @@ 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). + * failed password attempts (though they will be logged in any case). * * This directive is optional, but recommended. */ @@ -369,7 +369,7 @@ 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. + * disconnects. * * This directive is optional. */ @@ -434,8 +434,8 @@ 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. - * + * well. + * * This directive is optional. */ forceforbidreason = yes @@ -472,7 +472,7 @@ options /* * If set, Services will send global messages on starting up and shutting - * down/restarting. + * down/restarting. * * This directive is optional. */ @@ -493,7 +493,7 @@ options /* * If set, Services will hide the IRC operator's nick in a global - * message/notice. + * message/notice. * * This directive is optional. */ @@ -501,8 +501,8 @@ options /* * Prevents users from registering their nick if they are not connected - * for at least the given number of seconds. - * + * for at least the given number of seconds. + * * This directive is optional. */ #nickregdelay = 30 @@ -511,7 +511,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. + * 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 @@ -851,7 +851,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. + * 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. @@ -862,7 +862,7 @@ mail /* * If set, Services will not attempt to put quotes around the TO: fields - * in 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. @@ -914,14 +914,14 @@ 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. + * to the base names of the modules for NickServ. * * This directive is optional, but highly recommended. */ modules = "ns_help ns_register ns_group ns_identify ns_access ns_set ns_saset ns_set_autoop ns_set_email ns_set_greet ns_set_hide ns_set_kill ns_set_language ns_set_message ns_set_private ns_set_secure ns_saset_noexpire ns_drop ns_recover ns_release ns_sendpass ns_ghost ns_alist ns_info ns_list ns_logout ns_status ns_update ns_getpass ns_getemail ns_forbid ns_suspend ns_resetpass ns_ajoin" /* - * Force users to give an e-mail address when they register a nick. + * 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. */ @@ -978,28 +978,28 @@ nickserv regdelay = 30s /* - * The minimum length of time between consecutive uses of NickServ's RESEND command. + * 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. + * The length of time before a nick registration expires. * * This directive is optional, but recommended. If not set, the default is 21 days. */ expire = 21d /* - * The length of time before a suspended nick becomes unsuspended. + * The length of time before a suspended nick becomes unsuspended. * * This directive is optional. If not set, the default is to never. */ #suspendexpire = 90d /* - * The lenth of time before a forbidden nick drops. + * The lenth of time before a forbidden nick drops. * * This directive is optional. If not set, the default is to never. */ @@ -1007,14 +1007,14 @@ nickserv /* * 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. + * 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. + * 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. */ @@ -1039,7 +1039,7 @@ nickserv releasetimeout = 1m /* - * Allow the use of the IMMED option in the NickServ SET KILL command. + * Allow the use of the IMMED option in the NickServ SET KILL command. * * This directive is optional. */ @@ -1048,14 +1048,14 @@ nickserv /* * 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. + * flexibility. * * This directive is optional, but recommended. */ #nogroupchange = yes /* - * Limits the use of the NickServ LIST command to IRC operators. + * Limits the use of the NickServ LIST command to IRC operators. * * This directive is optional. */ @@ -1074,7 +1074,7 @@ 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). + * on other Services Admins or the Services Root(s). * * This directive is optional, but recommended. */ @@ -1090,7 +1090,7 @@ nickserv /* * If set, Services will set the channel modes a user has access to upon identifying, assuming - * they are not already set. + * they are not already set. * * This directive is optional. */ @@ -1131,7 +1131,7 @@ 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. + * to the base names of the modules for ChanServ. * * This directive is optional, but highly recommended. */ @@ -1168,23 +1168,23 @@ chanserv defaults="keeptopic peace secure securefounder signkick xop" /* - * The maximum number of channels which may be registered to a single nickname. + * The maximum number of channels which may be registered to a single nickname. * - * This directive is optional, but recommended. + * 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. + * The length of time before a channel registration expires. * - * This directive is optional, but recommended. + * This directive is optional, but recommended. * If not set, the default is 14 days. */ expire = 14d /* - * The length of time before a suspended channel becomes unsuspended. + * The length of time before a suspended channel becomes unsuspended. * * This directive is optional. * If not set, the default is to never. @@ -1192,9 +1192,9 @@ chanserv #suspendexpire = 90d /* - * The lenth of time before a forbidden channel drops. + * The lenth of time before a forbidden channel drops. * - * This directive is optional. + * This directive is optional. * If not set, the default is to never. */ #forbidexpire = 90d @@ -1233,7 +1233,7 @@ chanserv inhabit = 15s /* - * Limits the use of the ChanServ LIST command to IRC operators. + * Limits the use of the ChanServ LIST command to IRC operators. * * This directive is optional. */ @@ -1245,7 +1245,7 @@ chanserv listmax = 50 /* - * Allow only IRC Operators to use ChanServ. + * Allow only IRC Operators to use ChanServ. * * This directive is optional. */ @@ -1266,14 +1266,14 @@ memoserv nick = "MemoServ" /* - * The description of the MemoServ client, which will be used as the GECOS + * 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. + * to the base names of the modules for MemoServ. * * This directive is optional, but highly recommended. */ @@ -1282,8 +1282,8 @@ memoserv /* * 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. - * + * 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. */ @@ -1293,7 +1293,7 @@ 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. + * per second per user under the current IRC protocol. * * This directive is optional, but recommended. */ @@ -1302,7 +1302,7 @@ memoserv /* * 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. + * more efficient to enable this. * * This directive is optional. */ @@ -1334,7 +1334,7 @@ botserv nick = "BotServ" /* - * The description of the BotServ client, which will be used as the GECOS + * The description of the BotServ client, which will be used as the GECOS * (real name) of the client. */ description = "Bot Service" @@ -1390,7 +1390,7 @@ botserv * But some people may want to make it act like a real bot, that is, for example, remove all * the bans affecting the bot before joining the channel, remove a ban that affects the bot * set by an user when it is in the channel, and so on. Since it consumes a bit more CPU - * time, you should not enable this on larger networks. + * time, you should not enable this on larger networks. * * This directive is optional. */ @@ -1398,14 +1398,14 @@ 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 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. + * If set, BotServ will use case sensitive checking for badwords. * * This directive is optional. */ @@ -1422,9 +1422,9 @@ botserv /* * [OPTIONAL] HostServ Config * - * This section is used to set up the vHost Service pseudo-client. + * 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. + * 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. */ @@ -1436,15 +1436,15 @@ hostserv nick = "HostServ" /* - * The description of the HostServ client, which will be used as the GECOS + * 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. - * + * 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" @@ -1464,14 +1464,14 @@ operserv nick = "OperServ" /* - * The description of the OperServ client, which will be used as the GECOS + * The description of the OperServ client, which will be used as the GECOS * (real name) of the client. */ description = "Operator Service" /* * The core modules to load for OperServ. This is a space separated list that corresponds - * to the base names of the modules for OperServ. + * to the base names of the modules for OperServ. * * This directive is optional, but highly recommended. */ @@ -1480,7 +1480,7 @@ operserv /* * 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. + * users' modes, etc. * * This directive is optional. */ @@ -1499,7 +1499,7 @@ 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. + * been added. * * This directive is optional, but recommended. */ @@ -1507,7 +1507,7 @@ operserv /* * 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 eliminates the need for killingthe user after the SNLINE has been added. * *This directive is optional. */ @@ -1515,7 +1515,7 @@ operserv /* * 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 eliminates the need for killingthe user after the SQLINE has been added. * * This directive is optional. */ @@ -1570,21 +1570,21 @@ 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. + * 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. + * Sets the default expiry time for session exceptions. * * This directive is only required if session limiting is enabled. */ @@ -1593,7 +1593,7 @@ operserv /* * 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". + * reason for the impending kill as opposed to simply "Session limit exceeded". * * This directive is optional, if not set, nothing will be sent. */ @@ -1601,7 +1601,7 @@ operserv /* * 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. + * 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 @@ -1613,21 +1613,21 @@ 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. + * 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. + * 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. + * Adds the nickname of the IRC Operator issuing an AKILL to the kill reason. * * This directive is optional. */ @@ -1635,7 +1635,7 @@ operserv /* * If set, only IRC Operators will be permitted to use OperServ, regardless of module-based command - * access restrictions. + * access restrictions. * * This directive is optional, but recommended. */ @@ -1659,7 +1659,7 @@ global nick = "Global" /* - * The description of the Global client, which will be used as the GECOS + * The description of the Global client, which will be used as the GECOS * (real name) of the client. */ description = "Global Noticer" @@ -1728,14 +1728,14 @@ 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. + * 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. + * If set, Services will send a global message on DefCon level changes. * * This directive is optional. */ @@ -1743,7 +1743,7 @@ defcon /* * If set, Services will send the global message defined in the message directive on DefCon level - * changes. + * changes. * * This directive is optional. */ @@ -1751,7 +1751,7 @@ defcon /* * 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" @@ -1877,7 +1877,7 @@ m_helpchan { /* * For the given channel, every user that has or gets op status of the channel - * will automatically receive the +h user mode. + * will automatically receive the +h user mode. * * This directive is optional. */ diff --git a/docs/README b/docs/README index 16816d567..392fec882 100644 --- a/docs/README +++ b/docs/README @@ -1,285 +1,285 @@ -Anope -- a set of IRC services for IRC networks ------------------------------------------------ - -Anope is 2003-2011 Anope Team . -Based on Epona 2000-2002 PegSoft . -Based on Services 1996-1999 Andrew Church . - -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 - News system - * - Italian translation - * - Turkish translation - * Andrew Kempe - Session limiting - - Epona credits: - - * lara - Main coding - * CafeiN - Turkish translation - * Sylvain Cresto aka tost - FreeBSD 5 patch - * Marcelo Conde Foscarini aka Bras - Portuguese translation - * Alvaro Toledo aka POLLITO - Spanish translation - * chemical - German translation - * shine - German translation - * Guven Guzelbey aka MeShGuL - Turkish translation - * Jordi Pujol - Catalan translation - * Eva Dachs - Catalan translation - * Toni Perez - Catalan translation - * Sergios Karalis - Greek translation - * Thomas J. Stensas aka ShadowMaster - Ultimate 3.x support - - Anope credits: - - * Adam Kramer - * Adam - * Alvaro Toledo - * Amanda Folson - * Andrew Berquist - * Björn Stiddien - * Charles Kingsley - * Chris Hogben - * Daniel Engel - * David - * David Narayan - * David Robson - * Daniele Nicolucci - * Florian Schulze - * Gabriel Acevedo H. - * Jan Milants - * Jens Voss - * JH - * Joris Vink - * Lee Holmes - * Lucas Nussbaum - * Mark Summers - * Matthew Beeching - * Naram Qashat - * Phil Lavin - * Pieter Bootsma - * Robin Burchell - * Sean Roe - * Sebastian V - * Thomas Juberg Stensås - * Trystan .S Lee - * openglx - - Anope Translations: - - * GeniusDex (nl.l) - * Kein (ru.l) - * Maik Funke (de.l) - * Gabriel Acevedo H. (es.l) - * Janos Kapitany (hun.l) - * Szymon S'wierkosz (pl.l) - * Christopher N. (fr.l) - * Yusuf Kurekci (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 - 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=, 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. :) +Anope -- a set of IRC services for IRC networks +----------------------------------------------- + +Anope is 2003-2011 Anope Team . +Based on Epona 2000-2002 PegSoft . +Based on Services 1996-1999 Andrew Church . + +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 + News system + * + Italian translation + * + Turkish translation + * Andrew Kempe + Session limiting + + Epona credits: + + * lara + Main coding + * CafeiN + Turkish translation + * Sylvain Cresto aka tost + FreeBSD 5 patch + * Marcelo Conde Foscarini aka Bras + Portuguese translation + * Alvaro Toledo aka POLLITO + Spanish translation + * chemical + German translation + * shine + German translation + * Guven Guzelbey aka MeShGuL + Turkish translation + * Jordi Pujol + Catalan translation + * Eva Dachs + Catalan translation + * Toni Perez + Catalan translation + * Sergios Karalis + Greek translation + * Thomas J. Stensas aka ShadowMaster + Ultimate 3.x support + + Anope credits: + + * Adam Kramer + * Adam + * Alvaro Toledo + * Amanda Folson + * Andrew Berquist + * Björn Stiddien + * Charles Kingsley + * Chris Hogben + * Daniel Engel + * David + * David Narayan + * David Robson + * Daniele Nicolucci + * Florian Schulze + * Gabriel Acevedo H. + * Jan Milants + * Jens Voss + * JH + * Joris Vink + * Lee Holmes + * Lucas Nussbaum + * Mark Summers + * Matthew Beeching + * Naram Qashat + * Phil Lavin + * Pieter Bootsma + * Robin Burchell + * Sean Roe + * Sebastian V + * Thomas Juberg Stensås + * Trystan .S Lee + * openglx + + Anope Translations: + + * GeniusDex (nl.l) + * Kein (ru.l) + * Maik Funke (de.l) + * Gabriel Acevedo H. (es.l) + * Janos Kapitany (hun.l) + * Szymon S'wierkosz (pl.l) + * Christopher N. (fr.l) + * Yusuf Kurekci (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 + 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=, 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. :)