From 679d3c373fc8e570c2b4fe3c7eaceaf36815ca7c Mon Sep 17 00:00:00 2001 From: Charles Kingsley Date: Sat, 29 Jan 2011 11:58:59 +0000 Subject: Fixing leftover spaces and other rubbish I missed on the first pass. --- docs/README | 570 ++++++++++++++++++++++++++++++------------------------------ 1 file changed, 285 insertions(+), 285 deletions(-) (limited to 'docs') 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. :) -- cgit