diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CMakeLists.txt | 15 | ||||
| -rw-r--r-- | docs/README | 750 | ||||
| -rw-r--r-- | docs/WIN32.txt | 418 |
3 files changed, 599 insertions, 584 deletions
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 000000000..24b4eb85d --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,15 @@ +# We only need to install these docs on Windows as most Windows installations will be binary, not source +if(WIN32) + # Only install given files from this directory + # NOTE: I would've had this just find all files in the directory, but that would include files not needed (like this file) + execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/README ${CMAKE_CURRENT_BINARY_DIR}/README.txt) + if(IN_SOURCE) + # Add README.txt to list of files for CPack to ignore + add_to_cpack_ignored_files("README.txt$" TRUE) + endif(IN_SOURCE) + set(DOCS DEFCON FAQ INSTALL MODULES NEWS OLDCHANGES PROXY ${CMAKE_CURRENT_BINARY_DIR}/README.txt WIN32.txt) + install(FILES ${DOCS} + DESTINATION docs + ) + set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/README.txt") +endif(WIN32) diff --git a/docs/README b/docs/README index fb238f450..6371f9231 100644 --- a/docs/README +++ b/docs/README @@ -1,375 +1,375 @@ -Anope -- a set of IRC services for IRC networks ------------------------------------------------ - -Anope is 2003-2008 Anope Team <info@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> - * 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> - * 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> - * Pieter Bootsma <geniusdex@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) - * 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. - - * HelpServ, a skeleton service used to serve help files. - - Anope currently works with: - - * Bahamut 1.4.27 or later (including 1.8) - * Charybdis 1.0 or later - * DreamForge 4.6.7 - * Hybrid 7 or later - * InspIRCd 1.0 or later (including 1.1) - * Plexus 2.0 or later (including 3.0) - * PTlink 6.15 or later - * RageIRCd 2.0 beta-6 or later - * Ratbox 2.0.6 or later - * ShadowIRCd 4.0 beta 7 or later - * Solid IRCd 3.4.6 or later - * UltimateIRCd 2.8.2 or later (including 3.0) - * UnrealIRCd 3.1.1 or later (including 3.2) - * ViagraIRCd 1.3 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. - Anope will then use the defaults specified in the services.conf file, and - connect to the specified uplink server. Alternatively, any of the - following command-line options can be specified to change the default - values: - - -remote server[:port] Connect to the specified server - -local host -or- Connect from the specified address (e.g. for - [host]:[port] multihomed servers) - -name servername Our server name (e.g. services.some.net) - -desc string Description of us (e.g. SomeNet Services) - -user username Username for Services' nicks (e.g. services) - -host hostname Hostname for Services' nicks (e.g. esper.net) - -dir directory Directory containing Services' data files - (e.g. /usr/local/lib/services) - -log filename Services log filename (e.g. services.log) - -update secs How often to update databases (in seconds) - -expire secs How often to check for nick/channel - expiration (in seconds) - - Additionally, the following command-line options can be used to modify - 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, .db files and log not written - -skeleton Enable skeleton mode; like read-only mode, but only - OperServ is available - -nofork Do not fork after startup; log messages will be - written to terminal (as well as to the log file - if not in read-only mode) - -forceload Try to load as much of the databases as possible, - even if errors are encountered - -noexpire Expiration routines won't be run at all - -logchan Startup with logchan enabled - -version Display the version of Anope - -nothird Do not load the modules specified in ModulesAutoload - or ModulesDelayedAutoload in the config file - -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, open its - logfile, 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). - - If Anope is run with the "-skeleton" command-line option, it will not try - to load the nickname or channel databases, and will respond with "service - is inactive" messages to any commands sent to NickServ, ChanServ, - MemoServ or BotServ. This can be useful as an emergency stopgap measure - when the main copy of Anope cannot be started. - - 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 the -debug option more than once, 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 particular, at debug level 4 a message is written to the log for - every character received from the server). 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. - - The "-forceload" option is provided to attempt recovery of data from - corrupted or truncated databases. Normally, if Anope encounters an error - writing to a database file, it will attempt to restore the original - version of the file and report an error to the logfile and through - WALLOPS. However, if this should fail (which normally should not happen), - or if Anope is terminated abruptly e.g. by kill -9 or a power failure, - then one or more of the databases may be corrupt. Normally, this will - cause Anope to abort the next time you try to run it; however, if yo - give the -forceload option to Anope, it will instead read as much as it - can, then skip to the next database. For obvious reasons, it's highly - recommended to keep backup copies of your databases in case something - does happen (since Anope will stop at the first error in a database, even - with -forceload, meaning you lose any data after that). - -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 dev@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-2008 Anope Team <info@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>
+ * 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>
+ * 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>
+ * Pieter Bootsma <geniusdex@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)
+ * 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.
+
+ * HelpServ, a skeleton service used to serve help files.
+
+ Anope currently works with:
+
+ * Bahamut 1.4.27 or later (including 1.8)
+ * Charybdis 1.0 or later
+ * DreamForge 4.6.7
+ * Hybrid 7 or later
+ * InspIRCd 1.0 or later (including 1.1)
+ * Plexus 2.0 or later (including 3.0)
+ * PTlink 6.15 or later
+ * RageIRCd 2.0 beta-6 or later
+ * Ratbox 2.0.6 or later
+ * ShadowIRCd 4.0 beta 7 or later
+ * Solid IRCd 3.4.6 or later
+ * UltimateIRCd 2.8.2 or later (including 3.0)
+ * UnrealIRCd 3.1.1 or later (including 3.2)
+ * ViagraIRCd 1.3 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.
+ Anope will then use the defaults specified in the services.conf file, and
+ connect to the specified uplink server. Alternatively, any of the
+ following command-line options can be specified to change the default
+ values:
+
+ -remote server[:port] Connect to the specified server
+ -local host -or- Connect from the specified address (e.g. for
+ [host]:[port] multihomed servers)
+ -name servername Our server name (e.g. services.some.net)
+ -desc string Description of us (e.g. SomeNet Services)
+ -user username Username for Services' nicks (e.g. services)
+ -host hostname Hostname for Services' nicks (e.g. esper.net)
+ -dir directory Directory containing Services' data files
+ (e.g. /usr/local/lib/services)
+ -log filename Services log filename (e.g. services.log)
+ -update secs How often to update databases (in seconds)
+ -expire secs How often to check for nick/channel
+ expiration (in seconds)
+
+ Additionally, the following command-line options can be used to modify
+ 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, .db files and log not written
+ -skeleton Enable skeleton mode; like read-only mode, but only
+ OperServ is available
+ -nofork Do not fork after startup; log messages will be
+ written to terminal (as well as to the log file
+ if not in read-only mode)
+ -forceload Try to load as much of the databases as possible,
+ even if errors are encountered
+ -noexpire Expiration routines won't be run at all
+ -logchan Startup with logchan enabled
+ -version Display the version of Anope
+ -nothird Do not load the modules specified in ModulesAutoload
+ or ModulesDelayedAutoload in the config file
+ -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, open its
+ logfile, 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).
+
+ If Anope is run with the "-skeleton" command-line option, it will not try
+ to load the nickname or channel databases, and will respond with "service
+ is inactive" messages to any commands sent to NickServ, ChanServ,
+ MemoServ or BotServ. This can be useful as an emergency stopgap measure
+ when the main copy of Anope cannot be started.
+
+ 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 the -debug option more than once, 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 particular, at debug level 4 a message is written to the log for
+ every character received from the server). 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.
+
+ The "-forceload" option is provided to attempt recovery of data from
+ corrupted or truncated databases. Normally, if Anope encounters an error
+ writing to a database file, it will attempt to restore the original
+ version of the file and report an error to the logfile and through
+ WALLOPS. However, if this should fail (which normally should not happen),
+ or if Anope is terminated abruptly e.g. by kill -9 or a power failure,
+ then one or more of the databases may be corrupt. Normally, this will
+ cause Anope to abort the next time you try to run it; however, if yo
+ give the -forceload option to Anope, it will instead read as much as it
+ can, then skip to the next database. For obvious reasons, it's highly
+ recommended to keep backup copies of your databases in case something
+ does happen (since Anope will stop at the first error in a database, even
+ with -forceload, meaning you lose any data after that).
+
+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 dev@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. :)
diff --git a/docs/WIN32.txt b/docs/WIN32.txt index 241390271..30e2bf7f6 100644 --- a/docs/WIN32.txt +++ b/docs/WIN32.txt @@ -1,209 +1,209 @@ -Anope for Windows ------------------ - -1) Building the Source -2) Installation -3) Compiling Modules -4) Other compile options -5) Credits - -1) Building the Source - - NOTE: If you have downloaded one of the pre-compiled installers, you do - NOT need to complete this step, and you can proceed to step 2. - - If you want to build Anope from source on a Win32 system, you will need - to follow this instructions: - - 1) Download the required files: - - * Current Anope source: - http://sourceforge.net/project/showfiles.php?group_id=94081 - - If you have Visual C++ 6, 7 (.NET 2002/2003) or 8 (2005) skip ahead to step 2, else you - need to download the following free components from Microsoft. Once - downloaded, install these packages. - - * Microsoft Visual C++ 2008 Express Edition: - http://www.microsoft.com/express/vc/ - - or - - * Microsoft Visual C++ 2005 Express Edition: - http://msdn.microsoft.com/vstudio/express/visualc/download/ - - then download and install: - - * Microsoft Windows PlatformSDK: (Requires WGA validation) - http://www.microsoft.com/downloads/details.aspx?FamilyId=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en - - (NOTE: Although this says for Windows Server 2003, it does infact work on all supported - versions of Windows. When installing, you should select the Custom option, and ensure - that only the top selection, and the bottom selection are checked. This will cut down - install time dramatically) - - * MySQL for Windows (only needed if building with MySQL enabled): - http://dev.mysql.com/ - - (NOTE: Anope can be compiled against MySQL Version 3.23 and above) - - - 2) Unpack the Anope tarball with your favorite uncompression program - (WinZip or WinRAR, etc). - - 3) Bring up the Visual C++ Command Prompt; This will launch a - DOS Command Prompt like window, which will set the environment - properties needed to make Anope. - - Change directories to where you unpacked the source code in step 2, by typing: - - cd <path to extracted source> - - e.g. - - cd c:\anope-trunk - - 4) You now need to configure Anope to your requirements. At the prompt type: - - Config.bat - - NOTE: If you run an Anti-Virus program such as McAfee or Norton, you may - be unable to run this command due to the protection in place. Some Anti- - Virus programs may detect the Anope Configuration Tool as a worm, however - this is not the case. If you are prompted to allow or deny execution of - the script, you should choose allow. If the script fails to run, and no - notice is displayed, please check your Anti-Virus settings before seeking - assistance. - - An interactive configuration program should guide you through the install - options, and then detect your Microsoft Visual C++ Library files. If it - fails to detect them, you should check you have everything installed. - - If you cannot find whats causing the error, please visit our forums or - our IRC Support channel for assistance. - - 5) You are now ready to compile. At the prompt type: - - nmake -f Makefile.win32 - - Once you are back at the command prompt again, if there have been no - errors, you are ready to go. - - Should you encounter errors with the installation process, check the - messages displayed for advice on resolving them. If you are unable to - resolve the issues yourself, seek assistance on our forums or in our - IRC Support channel. - - 6) Anope will install the files where they belong. The only thing you need - to do is rename "data/example.conf" to be "data/services.conf". - - You have now completed the building phase of Anope for Windows. You can - now move on to the next section, which is related to setting up Anope. - -2) Installation - - Since Anope for Windows does not use a visual interface, you must do the - configuration with a text editor before proceeding with running Anope - itself. - - NOTE: You may need to open the configuration file with Wordpad, or a text - editor which supports UNIX line endings. Opening the configuration file in - Notepad will cause strange characters to appear, and you may not be able to - edit the file correctly. - - Open services.conf, and read through it carefully and adjust the settings - you think you need to adjust. Pay special attention to these settings: - - A) IRCDModule: This is the name of an IRCd Module that Anope will use - to communicate with your server. Anope supports 15 IRCds, - so ensure you set the right value here. - B) RemoteServer: This is the address to your ircd, along with the port - and password. You should consult your ircd - documentation on how to link ircds. - C) ServicesRoot: Remove the # and change the names to your nick so you - can take control of services once they are online. - D) UserKey1/2/3: Remove the # infront of the three UserKey settings, and - change the parameters to numbers; around 6-7 digits will - do. - - If you are unsure of the settings, you can go to the dos command prompt - and run "anope.exe -nofork -debug" and watch the information as it - attempts to connect. - - You can launch services in two ways. If you are sure that the entered - configuration information is correct, simply double clicking the Anope - executable will cause it to start; no window will pop up. If you'd rather - have a more textual output, you can start at the dos prompt and type in - "anope.exe". If services are successfully started up the dos prompt will - seem to hang; at this point you can safely close the dos window. - -3) Compiling Modules - - If you want to build other modules than the ones shipped by default, you - will need to modify the Makefile.inc.win32 file, in the src\modules folder. - - A) Add modules; find the line stating "SRCS=" and add the name of the - file to the end of the line. So if you have two files: - - SRCS=file.c file2.c - - If you are compiling a folder of module components, such as the example - "catserv", you will need to add/change the "SUBS=" line. If you were - compiling the "catserv" example, the line would look like this: - - SUBS=catserv - - B) When you've done this, use the same command prompt you set up in part - 1, change directories to the src\modules folder, and type: - - nmake -f Makefile.win32 - - followed afterwards, by: - - nmake -f Makefile.win32 install - - C) You should now be able to load your modules on IRC via OperServ, or via - the services.conf file. - - -4) Other compile options - - A) If you have trouble recompiling Anope, you should try: - - nmake -f Makefile.win32 distclean - - This will clean up the source directory and allow for chages to be applied - to previously compiled files. - - B) A list of valid options are: - - install - distclean - clean - spotless - all - core - protocols - mypasql - languages - modules - - The syntax for these options is: - - nmake -f Makefile.win32 [option] - -5) Credits - - Anope is based on Epona and IRCServices. See CREDITS for more credits and - a complete list of all developers. - - Anope's Windows-specific code is provided by: - - * Dominick Meglio <codemastr@unrealircd.com> - * Trystan Scott Lee <trystan@nomadirc.net> - * Chris Hogben <heinz@anope.org> - - Anope's Windows Installer was made using: - - * NSIS 2.20 <http://nsis.sourceforge.net> - +Anope for Windows
+-----------------
+
+1) Building the Source
+2) Installation
+3) Compiling Modules
+4) Other compile options
+5) Credits
+
+1) Building the Source
+
+ NOTE: If you have downloaded one of the pre-compiled installers, you do
+ NOT need to complete this step, and you can proceed to step 2.
+
+ If you want to build Anope from source on a Win32 system, you will need
+ to follow this instructions:
+
+ 1) Download the required files:
+
+ * Current Anope source:
+ http://sourceforge.net/project/showfiles.php?group_id=94081
+
+ If you have Visual C++ 6, 7 (.NET 2002/2003) or 8 (2005) skip ahead to step 2, else you
+ need to download the following free components from Microsoft. Once
+ downloaded, install these packages.
+
+ * Microsoft Visual C++ 2008 Express Edition:
+ http://www.microsoft.com/express/vc/
+
+ or
+
+ * Microsoft Visual C++ 2005 Express Edition:
+ http://msdn.microsoft.com/vstudio/express/visualc/download/
+
+ then download and install:
+
+ * Microsoft Windows PlatformSDK: (Requires WGA validation)
+ http://www.microsoft.com/downloads/details.aspx?FamilyId=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en
+
+ (NOTE: Although this says for Windows Server 2003, it does infact work on all supported
+ versions of Windows. When installing, you should select the Custom option, and ensure
+ that only the top selection, and the bottom selection are checked. This will cut down
+ install time dramatically)
+
+ * MySQL for Windows (only needed if building with MySQL enabled):
+ http://dev.mysql.com/
+
+ (NOTE: Anope can be compiled against MySQL Version 3.23 and above)
+
+
+ 2) Unpack the Anope tarball with your favorite uncompression program
+ (WinZip or WinRAR, etc).
+
+ 3) Bring up the Visual C++ Command Prompt; This will launch a
+ DOS Command Prompt like window, which will set the environment
+ properties needed to make Anope.
+
+ Change directories to where you unpacked the source code in step 2, by typing:
+
+ cd <path to extracted source>
+
+ e.g.
+
+ cd c:\anope-trunk
+
+ 4) You now need to configure Anope to your requirements. At the prompt type:
+
+ Config.bat
+
+ NOTE: If you run an Anti-Virus program such as McAfee or Norton, you may
+ be unable to run this command due to the protection in place. Some Anti-
+ Virus programs may detect the Anope Configuration Tool as a worm, however
+ this is not the case. If you are prompted to allow or deny execution of
+ the script, you should choose allow. If the script fails to run, and no
+ notice is displayed, please check your Anti-Virus settings before seeking
+ assistance.
+
+ An interactive configuration program should guide you through the install
+ options, and then detect your Microsoft Visual C++ Library files. If it
+ fails to detect them, you should check you have everything installed.
+
+ If you cannot find whats causing the error, please visit our forums or
+ our IRC Support channel for assistance.
+
+ 5) You are now ready to compile. At the prompt type:
+
+ nmake -f Makefile.win32
+
+ Once you are back at the command prompt again, if there have been no
+ errors, you are ready to go.
+
+ Should you encounter errors with the installation process, check the
+ messages displayed for advice on resolving them. If you are unable to
+ resolve the issues yourself, seek assistance on our forums or in our
+ IRC Support channel.
+
+ 6) Anope will install the files where they belong. The only thing you need
+ to do is rename "data/example.conf" to be "data/services.conf".
+
+ You have now completed the building phase of Anope for Windows. You can
+ now move on to the next section, which is related to setting up Anope.
+
+2) Installation
+
+ Since Anope for Windows does not use a visual interface, you must do the
+ configuration with a text editor before proceeding with running Anope
+ itself.
+
+ NOTE: You may need to open the configuration file with Wordpad, or a text
+ editor which supports UNIX line endings. Opening the configuration file in
+ Notepad will cause strange characters to appear, and you may not be able to
+ edit the file correctly.
+
+ Open services.conf, and read through it carefully and adjust the settings
+ you think you need to adjust. Pay special attention to these settings:
+
+ A) IRCDModule: This is the name of an IRCd Module that Anope will use
+ to communicate with your server. Anope supports 15 IRCds,
+ so ensure you set the right value here.
+ B) RemoteServer: This is the address to your ircd, along with the port
+ and password. You should consult your ircd
+ documentation on how to link ircds.
+ C) ServicesRoot: Remove the # and change the names to your nick so you
+ can take control of services once they are online.
+ D) UserKey1/2/3: Remove the # infront of the three UserKey settings, and
+ change the parameters to numbers; around 6-7 digits will
+ do.
+
+ If you are unsure of the settings, you can go to the dos command prompt
+ and run "anope.exe -nofork -debug" and watch the information as it
+ attempts to connect.
+
+ You can launch services in two ways. If you are sure that the entered
+ configuration information is correct, simply double clicking the Anope
+ executable will cause it to start; no window will pop up. If you'd rather
+ have a more textual output, you can start at the dos prompt and type in
+ "anope.exe". If services are successfully started up the dos prompt will
+ seem to hang; at this point you can safely close the dos window.
+
+3) Compiling Modules
+
+ If you want to build other modules than the ones shipped by default, you
+ will need to modify the Makefile.inc.win32 file, in the src\modules folder.
+
+ A) Add modules; find the line stating "SRCS=" and add the name of the
+ file to the end of the line. So if you have two files:
+
+ SRCS=file.c file2.c
+
+ If you are compiling a folder of module components, such as the example
+ "catserv", you will need to add/change the "SUBS=" line. If you were
+ compiling the "catserv" example, the line would look like this:
+
+ SUBS=catserv
+
+ B) When you've done this, use the same command prompt you set up in part
+ 1, change directories to the src\modules folder, and type:
+
+ nmake -f Makefile.win32
+
+ followed afterwards, by:
+
+ nmake -f Makefile.win32 install
+
+ C) You should now be able to load your modules on IRC via OperServ, or via
+ the services.conf file.
+
+
+4) Other compile options
+
+ A) If you have trouble recompiling Anope, you should try:
+
+ nmake -f Makefile.win32 distclean
+
+ This will clean up the source directory and allow for chages to be applied
+ to previously compiled files.
+
+ B) A list of valid options are:
+
+ install
+ distclean
+ clean
+ spotless
+ all
+ core
+ protocols
+ mypasql
+ languages
+ modules
+
+ The syntax for these options is:
+
+ nmake -f Makefile.win32 [option]
+
+5) Credits
+
+ Anope is based on Epona and IRCServices. See CREDITS for more credits and
+ a complete list of all developers.
+
+ Anope's Windows-specific code is provided by:
+
+ * Dominick Meglio <codemastr@unrealircd.com>
+ * Trystan Scott Lee <trystan@nomadirc.net>
+ * Chris Hogben <heinz@anope.org>
+
+ Anope's Windows Installer was made using:
+
+ * NSIS 2.20 <http://nsis.sourceforge.net>
+
|