From c777c8d9aa7cd5c2e9a399727a7fa9985a77fb1c Mon Sep 17 00:00:00 2001 From: sjaz Date: Thu, 1 Jan 2009 12:00:20 +0000 Subject: Anope Stable Branch git-svn-id: http://anope.svn.sourceforge.net/svnroot/anope/stable@1902 5417fbe8-f217-4b02-8779-1006273d7864 --- docs/BUGS | 4 + docs/COPYING | 339 +++++++++++++++ docs/DEFCON | 118 +++++ docs/EVENTS | 416 ++++++++++++++++++ docs/FAQ | 480 ++++++++++++++++++++ docs/INSTALL | 184 ++++++++ docs/IRCD | 601 +++++++++++++++++++++++++ docs/MODULES | 124 ++++++ docs/MYSQL | 109 +++++ docs/NEWS | 55 +++ docs/OLDCHANGES | 1299 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/OLDNEWS | 139 ++++++ docs/PROXY | 41 ++ docs/README | 377 ++++++++++++++++ docs/WIN32.txt | 209 +++++++++ 15 files changed, 4495 insertions(+) create mode 100644 docs/BUGS create mode 100644 docs/COPYING create mode 100644 docs/DEFCON create mode 100644 docs/EVENTS create mode 100644 docs/FAQ create mode 100644 docs/INSTALL create mode 100644 docs/IRCD create mode 100644 docs/MODULES create mode 100644 docs/MYSQL create mode 100644 docs/NEWS create mode 100644 docs/OLDCHANGES create mode 100644 docs/OLDNEWS create mode 100644 docs/PROXY create mode 100644 docs/README create mode 100644 docs/WIN32.txt (limited to 'docs') diff --git a/docs/BUGS b/docs/BUGS new file mode 100644 index 000000000..1f640fa5e --- /dev/null +++ b/docs/BUGS @@ -0,0 +1,4 @@ +Reported Bugs from Bugzilla: http://bugs.anope.org/ +--------------------------------------------------- + + diff --git a/docs/COPYING b/docs/COPYING new file mode 100644 index 000000000..a43ea2126 --- /dev/null +++ b/docs/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 675 Mass Ave, Cambridge, MA 02139, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 19yy + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19yy name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/docs/DEFCON b/docs/DEFCON new file mode 100644 index 000000000..1f5218d19 --- /dev/null +++ b/docs/DEFCON @@ -0,0 +1,118 @@ +Anope DefCon +------------ + +1) Introduction +2) Installation +3) Configuration +4) Usage +5) Usage Example +6) Support + +1) Introduction + + Anope 1.6 onwards supports a unique protection mechanism based on the + military "Defense Readiness Condition" (DefCon) system. It is based on + 5 levels of defense readiness defined as: + + DEFCON5 Normal peacetime readiness + DEFCON4 Increased intelligence and security readiness + DEFCON3 Increase in force readiness + DEFCON2 Further increase in force readiness + DEFCON1 Maximum force readiness. + + These are configurable levels that mandates what actions Anope should + take in case of emergency and change in readiness status. + + It is used to prevent abuse to both Services, and the ircd on which they + are running. Also to protect the users, primarily in the event of Clones + and/or FloodBOT attacks. + +2) Installation + + The DefCon system is part of Anope's core, + + The DefCon system has to be configured on your services.conf file to + be enabled. All directives are optional unless they depend on what + options you enable for each level. Look for the "DefCon configuration" + section on your services.conf file for more information. + + Make sure you restart Anope after changing the DefCon configuration + directives. + +3) Configuration + + Pre-defined DefCon actions: + + No new channel registrations 1 + No New Nick Registrations 2 + No MLOCK changes 4 + Force Chan Mode 8 + Use Reduced Session Limit 16 + KILL any new clients trying to connect 32 + Services will ignore everyone but opers 64 + Services will silently ignore everyone but opers 128 + AKILL all new clients trying to connect 256 + No new memos sent to block MemoServ attacks 512 + + These are the values used to determine each defcon setting, are set via: + + DefCon1 XX + DefCon2 XX + DefCon3 XX + DefCon4 XX + + To set the desired value, you simply add the value of the numbers together + and place that as your DefCon# setting. For instance: + + Say you wish to set: + + No Channel Registrations, No Nickname Registrations and Services Ignoring + everyone except for Operators. You would do this by: + + 1 + 2 + 128 (Each value listed above is added together) + Giving: 131 + + You would then place this as which ever Defcon setting you want: + + DefCon1 131 + + The recommended default values are safe to use on any network. + +4) Usage + + Anope starts up in DEFCON5 (normal readiness). To change the Defcon level + in action use: + + /msg OperServ DEFCON 1|2|3|4|5 + +5) Usage Example + + Place the network on DEFCON4: + + /msg OperServ DEFCON 4 + + *** Global -- from OperServ: dengel Changed the DEFCON level to 4 + + -OperServ- Services are now at DEFCON 4 + -OperServ- * No new channel registrations + -OperServ- * No new nick registrations + -OperServ- * No MLOCK changes + -OperServ- * Use the reduced session limit of 5 + + -Global- The Defcon Level is now at Level: 4 + + Restore normal readiness: + + /msg OperServ DEFCON 5 + + *** Global -- from OperServ: dengel Changed the DEFCON level to 5 + + -OperServ- Services are now at DEFCON 5 + + -Global- Services are now back to normal, sorry for any inconvenience + +6) Support + + You might get DefCon support by posting on our online forum, or maybe on + our #anope channel at /server irc.anope.org. + diff --git a/docs/EVENTS b/docs/EVENTS new file mode 100644 index 000000000..bc8af9dce --- /dev/null +++ b/docs/EVENTS @@ -0,0 +1,416 @@ +Anope Internal Events +--------------------- + +1) Intro +2) Complex Events +3) Triggered Events +4) Triggered Events List + +1) Introduction to Internal Events + + Internal Events are setup to give module developers more information + about what the core is doing at different times. This information can + be as complex as data we are feeding to the uplink, to simple triggered + events such as the databases being saved. A list of triggered events + can be found below. Additional there is a module included with the core + which can provide some clue as to how to use the code in your modules. + The rest of this document assumes that you are used to writing modules. + +2) Complex Events + + This type of events are based around what happens when we talk to the + IRCd, much like MESSAGE events that the IRCD sends to us. The events + are triggered when Anope writes to the ircd. To watch for these events + you must have some knowledge of how the IRCd command system works. In + our example we will trap for NICK events. + + A) All functions most be formatted as: + + int functioname(char *source, int ac, char **av); + + B) In AnopeInit you must declare EvtMessage in some fashion, it is into + this variable that we will create the event handler. Here is what the + base AnopeInit should look like at this point: + + int AnopeInit(int argc, char **argv) + { + EvtMessage *msg = NULL; + int status; + + moduleAddAuthor(AUTHOR); + moduleAddVersion(VERSION); + return MOD_CONT; + } + + Note that AUTHOR and VERSION should be defined above the AnopeInit + function, just like you should do with any module. + + C) Pass "createEventHandler" the name of the message in this case NICK, + and the function that was created in Step A. At this point you should + assign the return of "createEventHandler" to the EvtMessage variable. + + msg = createEventHandler("NICK", my_nick); + + D) The Handler is not ready for use yet; now you must add it to the hash + with "moduleAddEventHandler". You will want to pass to this function + the return of "createEventHandler". + + status = moduleAddEventHandler(msg); + + It will return the same module error codes as adding a regular message, + which you can use to confirm it was added correctly. + + E) With that setup in your function you will be passed 3 items. The source + most of the time this will be set to ServerName or NULL; consult our + IRCd documentation about how messages are formatted. AC is the count of + variables you will find in AV. + + int my_nick(char *source, int ac, char **av) + { + alog("Internal Event - nick is %s",av[0]); + return MOD_CONT; + } + +3) Triggered Events + + These events also known as "event hooks" are internal events such as + expiring of nicks to the saving of databases. + + A) All functions most be formatted as: + + int functioname(int argc, char **argv); + + B) In AnopeInit you must declare EvtHook in some fashion; it is into + this variable that we will create the event handler. Here is what + the base AnopeInit should look like at this point: + + int AnopeInit(int argc, char **argv) + { + EvtHook *hook = NULL; + int status; + + moduleAddAuthor(AUTHOR); + moduleAddVersion(VERSION); + return MOD_CONT; + } + + C) Pass "createEventHook" the name of the event. In this case we are + going to hook to the saving of databases, "EVENT_DB_SAVING". + + hook = createEventHook(EVENT_DB_SAVING, my_save); + + D) The Handler is not ready for use yet; now you must add it to the hash + with "moduleAddEventHook". You will want to pass to this function the + return of "createEventHook" + + status = moduleAddEventHook(hook); + + It will return the same module error codes as adding a regular message, + which you can use to confirm it was added correctly. + + E) With that setup in your function you will be passed 1 item. The message + is very simple; it could be as simple as a start, stop or message. In + the case of saving it has a start and stop. + + int my_save(int argc, char **argv) + { + if (argc < 1) { + return MOD_CONT; + } + + if (!stricmp(argv[0], EVENT_START)) { + alog("Saving the databases! has started"); + } else { + alog("Saving the databases is complete"); + } + return MOD_CONT; + } + +4) Triggered Events List + + Here's a list of all event hooks we currently offer, with a description + of what argument is being passed to the event functions for this type of + event. All arguments are plain-text strings (char *). The list is sorted + in alphabetical order. + + Note that all events are emitted AFTER the action has taken place, so + any deleted nick/channel/etc won't exist anymore and any created one will + exist when your function is being run, unless noted otherwise. + + Also note that EVENT_START and EVENT_STOP should not be matched with an + equal sign, but with string comparision. See the bundled events module for + an example on how to do this. + + The arguments are given as av[0] for the first argument, av[1] for the + second argument, and so on. If av[0] and av[1] are given, the event has + two arguments, and argc should be 2. + + EVENT_ACCESS_ADD + An user has been added to a channel access list. + av[0] Name of the channel the user has been added to. + av[1] The nickname of the user that has just added an entry to the + access list. + av[2] The nickname of the user that has been added to the access + list. + av[3] The level number the user has been added with. + + EVENT_ACCESS_CHANGE + An user level has been changed on a channel access list. + av[0] Name of the channel the access list has been modified which. + av[1] The nickname of the user that has just modified the access + list of the channel. + av[2] The nickname of the user wich his access level has just been + modified. + av[3] The new access level for the user. + + EVENT_ACCESS_CLEAR + A channel access list has been cleared. + av[0] Name of the channel the access list has been cleared of + av[1] The nickname of the user that has cleared the access list + + EVENT_ACCESS_DEL + An user has been deleted of a channel access list. + av[0] Name of the channel the access entry has been deleted which. + av[1] The nickname of the user that has just deleted the access entry. + av[2] [OPTIONAL] The nickname of the user wich his access level has just + been removed. Not present if numbers were used (e.g. /cs access + del 7). + + EVENT_BOT_ASSIGN + A BotServ bot has been assigned to a channel. + av[0] Name of the channel the bot has been assigned to. + av[1] The nickname of the bot that has been assigned to the channel. + + EVENT_BOT_BAN + A BotServ bot has banned a user, e.g. kickers. + av[0] The nick of the user banned. + av[1] The Channel the user was banned from. + av[2] The mask that was banned. + + EVENT_BOT_CHANGE + The properties of a BotServ bot have been changed. + av[0] The nickname of the bot involved. + + EVENT_BOT_CREATE + A new BotServ bot has been created, and is ready to use. + av[0] The nickname of the newly created bot. + + EVENT_BOT_DEL + A BotServ bot is being deleted from BotServ. This event is being sent + just before the actual deletion is performed. + av[0] The nickname of the bot being deleted. + + EVENT_BOT_FANTASY + A fantasy command of the bot has been triggered. This event should be + used to create your own fantasy commands. + av[0] The fantasy command that has been triggered without leading '!'. + av[1] The nickname of the user that has triggered the fantasy + command. + av[2] The name of the channel the fantasy command has been triggered + on. + av[3] Contains any optional paramenters passed after the fantasy + command. If none are present, this will not exist, and argc will + will be 3. + + EVENT_BOT_FANTASY_NO_ACCESS + A fantasy command of the bot has been triggered by someone without + access to BotServ FANTASY commands on the channel. This will NOT + trigger if someone with access has triggered a fantasy command; use + EVENT_BOT_FANTASY for those. Hook to both events to catch both event + triggers. + av[0] The fantasy command that has been triggered without leading '!'. + av[1] The nickname of the user that has triggered the fantasy + command. + av[2] The name of the channel the fantasy command has been triggered + on. + av[3] Contains any optional paramenters passed after the fantasy + command. If none are present, this will not exist, and argc will + will be 3. + + EVENT_BOT_JOIN + A BotServ bot has joined a channel and opped itself. + av[0] The channel name the bot has just joined. + av[1] The nickname of the bot that has joined the channel. + + EVENT_BOT_KICK + A BotServ bot has kicked a user from a channel. + av[0] The name of the user that has been kicked. + av[1] The name of the channel the user was kicked from. + av[2] The reason for the kick. + + EVENT_BOT_UNASSIGN + A BotServ bot is being unassigned from a channel. This event is being + sent before the actual removing of the bot is done. + av[0] The channel name the bot has been unassigned from. + av[1] The nickname of the bot that has been unassigned. + + EVENT_CHAN_DROP + A channel has been dropped and deleted. + av[0] The name of the channel that has been dropped. + + EVENT_CHAN_EXPIRE + A channel has been expired and will be deleted. The event will be + emitted just before the actual channel deletion happens. + av[0] The name of the channel that has been expired. + + EVENT_CHAN_FORBIDDEN + A channel has been forbidden (ChanServ FORBID). + av[0] The name of the channel that has been forbidden. + + EVENT_CHAN_KICK + Someone has just been kicked from a channel. + av[0] The nick of the user that has been kicked. + av[1] The channel the user has been kicked from. + + EVENT_CHAN_REGISTERED + A new channel has been registered. + av[0] The name of the channel that has been registered. + + EVENT_CHAN_SUSPENDED + A channel has been suspended (ChanServ SUSPEND). + av[0] The name of the channel that has been suspended. + + EVENT_CHAN_UNSUSPEND + A channel has been unsuspended (ChanServ UNSUSPEND). + av[0] The name of the channel that has been unsuspended. + + EVENT_CHANGE_NICK + A user has just changed it's nick. + av[0] The new nickname of the user. + + EVENT_CONNECT + This event is emitted when the connection to our uplink hub is being + made. + av[0] EVENT_START or EVENT_STOP, to indicate if it's emitted before + or after the connection has been made. EVENT_STOP is emitted + before our burst is being sent over the link. + + EVENT_DB_EXPIRE + This event is emitted when the expiry routines for all things that can + expire in Anope are being run. + av[0] EVENT_START or EVENT_STOP, to indicate if it's being emitted + before or after the expiry routines have been run. + + EVENT_DB_SAVING + This event is emitted when the databases are being saved. + av[0] EVENT_START or EVENT_STOP, to indicate if it's emitted before + or after the saving routines have been run. + + EVENT_DB_BACKUP + This event is emitted when the databases are backed up. + av[0] EVENT_START when the backup commences, and EVENT_STOP when it + finishes. + + EVENT_DEFCON_LEVEL + The DefCon level has just been changed. This event is emitted before + any DefCon-related action is taken. The internal DefConLevel has + already been raised at this point. + av[0] The new level of DefCon being invoked. + + EVENT_GROUP + A user has grouped it's nickname to another user group. + av[0] The nickname of the user that joined the group. + + EVENT_JOIN_CHANNEL + A user joins a channel. + av[0] EVENT_START or EVENT_STOP. EVENT_START when the user has passed + all access checks and is allowed to join, but has not yet + joined the channel. EVENT_STOP when the user has joined and all + needed modes are set etc. + av[1] The nickname of the user joining the channel. + av[2] The name of the channel the user has joined. + + EVENT_NEWNICK + A new user has been introduced on the network. + av[0] The nickname of the newly introduced user. + + EVENT_NICK_DROPPED + A user's nick has just been dropped. Note that the nickname information + has already been deleted! + av[0] The nickname of the user that has just been dropped. + + EVENT_NICK_EXPIRE + A user's nick has just expired. Note that, as with EVENT_NICK_DROPPED, + the nickname information has already been deleted! + av[0] The nickname of the user that has just expired. + + EVENT_NICK_FORBIDDEN + A user's nick has just been forbidden. + av[0] The nickname that has just been forbidden. + + EVENT_NICK_IDENTIFY + A user has just identified for it's nickname with NickServ. + av[0] The nickname of the user that just identified. + + EVENT_NICK_LOGOUT + A user has just (been) logged out. + av[0] The nickname of the user that has (been) logged out. + + EVENT_NICK_REGISTERED + A new user has just registered it's nickname. This event is being + emitted when the registration is completed, but the user modes have not + yet been set. + av[0] The nickname of the newly registered user. + + EVENT_NICK_SUSPENDED + A user's nick has just been suspended. + av[0] The nickname that has just been suspended. + + EVENT_NICK_UNSUSPEND + A user's nick has just been unsuspended. + av[0] The nickname that has just been unsuspended. + + EVENT_PART_CHANNEL + A user parts a channel. + av[0] EVENT_START or EVENT_STOP. EVENT_START when the user is about + to be removed from the channel internally, EVENT_STOP when + this has been done. + av[1] The nickname of the user parting the channel. + av[2] The name of the channel the user has parted. + av[3] The reason the user parted the channel, this is not always sent + so check the count to make sure it was passed. (ac == 4) + + EVENT_RELOAD + This event is emitted after the configuration file has been reloaded. + av[0] Always EVENT_START. + + EVENT_RESTART + This event is emitted before the services are being restarted. + av[0] Always EVENT_START. + + EVENT_SERVER_CONNECT + A new server has just connected to the network. + av[0] The name of the new server. + + EVENT_SERVER_SQUIT + A server has sent an SQUIT and is about to be removed from the + network. This event is being sent before the server is actually + removed from the network. + av[0] The name of the server that is being removed. + + EVENT_SHUTDOWN + This event is emitted when Anope is being shut down. + av[0] EVENT_START or EVENT_STOP, to indicate where in the process of + restarting the core is. With EVENT_START, services are still + fully online and operating. With EVENT_STOP, every internal + clean up has been done already, and the SQUIT has been sent; + the only thing done after emitting the event is closing the + socket to the uplink hub. + + EVENT_SIGNAL + This event is emitted when Anope is quitting because of a signal it + received. + av[0] The quit message that will be sent with the SQUIT for this + shutdown. + + EVENT_TOPIC_UPDATED + A channel topic has been succesfully updated. Note that this event is + only emitted if the new topic has been fully accepted and set by the + Anope core. + av[0] The name of the channel involved. + av[1] The new topic set on the channel. + + EVENT_USER_LOGOFF + A user has left the network. This event is emitted before the internal + removal is performed, so the user still exists internally. + av[0] The nickname of the user leaving the network. diff --git a/docs/FAQ b/docs/FAQ new file mode 100644 index 000000000..93c069f0b --- /dev/null +++ b/docs/FAQ @@ -0,0 +1,480 @@ +Frequently Asked Questions (FAQ) concerning Anope +------------------------------------------------ + +NOTE: +An updated version of this FAQ can be found on our website: www.anope.org + +Table of Contents +----------------- + +1) General + 1.1) What is Anope? + 1.2) Where can I find Anope? + 1.3) Does Anope run under Windows? + 1.4) Can I send you questions without reading the FAQ, INSTALL or README + files? + 1.5) I need support for the XYZ protocol. + 1.6) Your Services program doesn't do XYZ like DALnet (or other) Services. + What's wrong? + 1.7) I've got a great new idea for Services. Do you want it? + 1.8) Examples of features we have been asked about and why we won't add (or + haven't yet added) them, so don't ask us about them: + 1.9) Can you help me? + 1.10) Where is RootServ? + +2) Installation / Configuration + 2.1) When I run "make", I get an error message like "missing separator", + "Unassociated shell command", "Unexpected end of line seen", etc. + 2.2) I get an error like "Makefile.inc not found". + 2.3) I typed "./services" at the command line, but nothing happened! + 2.4) Whenever I start Anope, I get a message on my IRC server saying + "connection refused" or something similar, and Anope gives an error + message from the server saying "Closing Link: ...". + 2.5) My IRC server is giving me messages like "Connection to + services.whatever.net[127.0.0.1] activated" and then "Access denied -- + no N line". Why? + 2.6) When I say "/connect services.*", it doesn't work! + 2.7) Anope starts up okay, but if I try to register a nickname, it comes + back with "Sorry, registration failed." + 2.8) Anope reports (via /stats u or /msg OperServ STATS) a different number + of users online than I get from doing /lusers. + +3) OperServ + 3.1) Using the OperServ JUPE command results in server messages like + "Server juped.server introduced by non-hub server services.my.net". + 3.2) I can't use the ADMIN command to add Services admins, it tells me + "Permission denied." + 3.3) When I add an AKILL, the users matching it don't get killed. + 3.4) Trying to use OperServ gives me "Access denied", but my nick is in the + ServicesRoot directive and is registered, and I've identified for my + nick. + 3.5) When I used the OperServ RAW command, Anope and/or my network crashed, + or did weird things! Please fix this bug! + 3.6) I would like to have the list of the different RAW on OperServ. + 3.7) I can't get /OS UMODES and /OS SVSNICK to work! + 3.8) What is a Super-Admin? How does it work? Why might it not work? + 3.9) How can i enable the OperServ RAW command? + +4) Bugs / Crashes + 4.1) Anope always dies after about five minutes, saying "FATAL ERROR! Can't + back up nick.db". + 4.2) Anope crashed with a segmentation fault. + 4.3) I've found a bug that's not mentioned here or in the README or BUGS + files. What should I do? + 4.4) My FreeBSD box complains about 'Shared object "nss_dns.so.1" not + found' + 4.5) Anope and long (more then 30 character) nicknames. + +5) ChanServ + 5.1) Anope's channel mode setting doesn't work. I can't set modes with + OperServ, and every time ChanServ tries to set a mode, my server + reverses the change. + 5.2) Anope ignored the SET SUCCESSOR setting and deleted a channel when the + founder expired. + 5.3) How to auto voice all those whom join my #channel? + 5.4) Channel options like RESTRICTED or SECUREOPS don't work. What's wrong? + +6) BotServ + 6.1) How do I add bots to BotServ? + 6.2) Why do kick triggers and fantasy commands fail to work with my Bahamut + IRCd? + +7) Language + 7.1) Anope complains in the logfile about being unable to load the default + language. + 7.2) Anope spricht kein Deutsch!, etc. (Anope doesn't speak my language!) + 7.3) I selected a language other than English, but sometimes Anope sends + responses in English instead. + +8) DevNull + 8.1) What is the purpose of DevNull? + +------------------------------------------------------------------------------- + +1) General + +1.1) What is Anope? + + Anope is a set of services for IRC networks. See the README file for more + information. And in case you were wondering, Anope is Epona spelt backwards + :) + +1.2) Where can I find Anope? + + The latest version can always be found at the official Anope distribution + site: + + * http://www.anope.org/ + + New version announcements can also be found at http://www.anope.org/ in the + main page. + +1.3) Does Anope run under Windows? + + Yes. For more information on how to obtain the windows version of Anope + visit http://wiki.anope.org/Windows + +1.4) Can I send you questions without reading the FAQ, INSTALL or README files? + + No. If you don't read those files, your messages will most probably be + ignored. We don't mean to be rude, but if we took the time to write down + some documentation, we'd expect you to take some time to read it. + +1.5) I need support for the XYZ protocol. + + Since Anope 1.7.9, support for other IRCD's, and thus protocols, has been + made modular. More information on making a support file for your favorite + IRCD can be found in the docs/IRCD file. + +1.6) Your Services program doesn't do XYZ like DALnet (or other) Services. + What's wrong? + + Nothing is wrong, except your expectations. Anope is a completely + different program from that used on DALnet; they are similar in concept + only. + +1.7) I've got a great new idea for Services. Do you want it? + + We are always interested in hearing new ideas. HOWEVER, do not expect your + proposal to be in the next Anope release for sure. As a rule, we usually + don't add anything that can be equivalently done by other means, or that we + consider totally useless; see question 1.8 for examples of things we don't + plan to add. + + Our general intent is for Anope to provide as much functionality as + possible--while staying as lean as possible. So features which are + arguably beneficial will tend to be added, while features of limited or no + benefit or which can be equally provided by something else already in use + will tend to be passed over. + + If you'd like to give us your idea, you can go to our website at + http://www.anope.org/ and add it on our online Forum, in the Feature + Requests section. + +1.8) Examples of features we have been asked about and why we won't add (or + haven't yet added) them, so don't ask us about them: + + * An option to make ChanServ stay in some/all registered channels: we see + absolutely no necessity for this feature, since BotServ already does this + anyway. + + * A "current time" field in NickServ and ChanServ INFO displays: Most + people have clocks of some sort either on their computer screens or on + their walls (or both), and all IRC servers, as well as Services, have a + command to return the server's current time. Thus a current-time field in + INFO displays would simply take up extra space for no reason. + +1.9) Can you help me? + + No, we can't help you unless you tell us what you need help with. + +1.10) Where is RootServ? + + Anope does not supply RootServ. All functions you would find in RootServ + have been integrated into OperServ. If you really want to use RootServ, you + can set the OperServAlias in services.conf to be RootServ. This will enable + the RootServ nick to be used for OperServ as well. Read the comments near + OperServAlias in the configuration file for more information. + + +2) Installation / Configuration + +2.1) When I run "make", I get an error message like "missing separator", + "Unassociated shell command", "Unexpected end of line seen", etc. + + Your make program isn't compatible with the Makefile for Anope. The + Makefile was designed to work with GNU make, and as such may not work on + other systems' "make" programs. If you get an error from "make", obtain + GNU make from ftp://prep.ai.mit.edu/pub/gnu/ (or wherever you prefer) and + use it instead of your system's default "make". Note that GNU make may + already be installed on your system; try using the command "gmake" instead + of "make". + + The make programs bundled with SunOS/Solaris and FreeBSD have been reported + not to work; you will need to use GNU make on these systems. + +2.2) I get an error like "Makefile.inc not found". + + You forgot to run the Config script first. See the INSTALL file for + compilation instructions. + +2.3) I typed "./services" at the command line, but nothing happened! + + Anope puts itself in the background when it starts, so you get your shell + prompt right back. Meanwhile, Anope will continue setting up, then connect + to the IRC server specified in services.conf (or on the command line). If + it doesn't connect, you probably specified the wrong server type in the + configuration file. (Also make sure that you are actually running one of + the supported servers. There are a gazillion different variations on the + basic IRC protocol out there, and we have neither the time nor the desire + to add support for them.) + + The recommended server, under which Epona (the original code base used by + Anope) was developed, is Bahamut. DreamForge 4.6.7 will also work fine, but + it's a bit obsolete nowadays. Derivatives of Bahamut and DreamForge may + also work, if they don't change the server<->server protocol too much; + contact their authors for more information. Most people, though, are + running Anope with UnrealIRCd, UltimateIRCd or Bahamut. + + As always, you can check the log file (services.log by default) for error + messages. You can also start services with the -nofork command line option + to prevent it from running in the background, and it will output the + messages written to the log file to the console as well. + +2.4) Whenever I start Anope, I get a message on my IRC server saying + "connection refused" or something similar, and Anope gives an error + message from the server saying "Closing Link: ...". + + See section 3 of the INSTALL file. + +2.5) My IRC server is giving me messages like "Connection to + services.whatever.net[127.0.0.1] activated" and then "Access denied -- no + N line". Why? + + This is typically caused by including a port number in the C:line for + services, which tells your server to try to autoconnect to it (depending on + the class (Y:line) settings). This is not what you want, because Anope + will connect to the server itself, but does not listen for servers to + connect to it. The solution is to remove the port number from the C:line. + +2.6) When I say "/connect services.*", it doesn't work! + + Of course not. RTFM (Read The Fine Manual), and see the previous answer. + +2.7) Anope starts up okay, but if I try to register a nickname, it comes back + with "Sorry, registration failed." + + Make sure you've selected the correct IRC server type in the configure + script; see question 2.4 for details. + +2.8) Anope reports (via /stats u or /msg OperServ STATS) a different number of + users online than I get from doing /lusers. + + Anope doesn't count its own pseudo-clients (NickServ, ChanServ, etc.) in + its user count, while the IRC server does. + + +3) OperServ + +3.1) Using the OperServ JUPE command results in server messages like "Server + juped.server introduced by non-hub server services.my.net". + + Services' uplink must have an H: line for Services in the ircd.conf file, + which looks something like: + + H:*::services.whatever.net + +3.2) I can't use the ADMIN command to add Services admins, it tells me + "Permission denied." + + Did you define yourself as the Services root? You need to insert your + nickname in the ServicesRoot directive in services.conf. Also, you must be + a global IRC Operator and your nickname must be registered and properly + indentified with NickServ. + +3.3) When I add an AKILL, the users matching it don't get killed. + + Use the AkillOnAdd configuration directive. + +3.4) Trying to use OperServ gives me "Access denied", but my nick is in the + ServicesRoot directive and is registered, and I've identified for my nick. + + You need to be a global oper (i.e. user mode +o) to access OperServ. This + can be configured via the OSOpersOnly directive in services.conf . + +3.5) When I used the OperServ RAW command, Anope and/or my network crashed, or + did weird things! Please fix this bug! + + "That's not a bug, it's a feature." + + Have you ever typed /msg OperServ HELP RAW? It's clearly stated there that + this command is dangerous and that its use may result in very bad things. + + And that's why this command has been disabled by default. If you enabled + and used it, YOU'RE ON YOUR OWN. All help requests will be ignored, even if + the problem happens not immediately. + +3.6) I would like to have the list of the different RAW on OperServ. + + If you have to ask, you should not be messing with RAW :) + +3.7) I can't get /OS UMODES and /OS SVSNICK to work! + + You need to be a SuperAdmin to be able to use these commands. + +3.8) What is a Super-Admin? How does it work? Why might it not work? + + Super-Admin's have extra privileges, including being founder on all + channels. It must be activated on a per user basis and is only available to + Services Roots. It is set using OperServ and is not persistent. It only + works if SuperAdmin is not commented in the services configuration file. + This is commented by default. Read /msg OperServ HELP SET SUPERADMIN for + further help. + +3.9) How can i enable the OperServ RAW command? + + Enabling the OperServ RAW command is VERY dangerous and should never be + done on a real network without thinking about it very well first. The RAW + command can easily break your whole network if used incorrectly, and thus + you will receive NO SUPPORT if you enable RAW on your network. + + Before you enable RAW, be very sure you really want to enable it, and keep + in mind that you will NOT BE ABLE to receive ANY SUPPORT anymore, because + Anope's stability cannot be guaranteed if RAW is enabled. + + The RAW command comes bundled as a core module for operserv. To load it, + add the os_raw module to the list of OperServ core modules. But be sure to + keep in mind that when you enable the RAW command, you CANNOT GET ANY + SUPPORT for Anope anymore. + + +4) Bugs / Crashes + +4.1) Anope always dies after about five minutes, saying "FATAL ERROR! Can't + back up nick.db". + + Make sure that the user Anope runs as has write access to the data + directory, and that the data directory actually exists (the latter + shouldn't be a problem if you ran the Config script). This means Anope + needs write and execute permission on the data directory itself and execute + permission on every parent directory of the data directory. + +4.2) Anope crashed with a segmentation fault. + + See if you can reproduce this by doing a certain sequence of things. If + so, please report it to us (see part 6 of README file). If not, you're + probably out of luck; if you like, you can report it to us anyway, but + chances are it won't get fixed if we don't have instructions on reproducing + it. If you do have such a problem, you may find the crontab utility useful + for dealing with it. + + Also, see the DumpCore directive in the configuration file. It allows Anope + to dump its core whenever it's segfaulting, usually calling it core and + placing it into Anope's main directory. Open up gdb by issuing the + following command at your shell: + + * gdb services core + + (of course replacing 'core' with the name of the core if different) and + type 'bt' at the gdb prompt. After that, send us the output you got and + keep the core file in a safe place, in case we need it to dig deeper into + the problem. + +4.3) I've found a bug that's not mentioned here or in the README or BUGS files. + What should I do? + + See section 6 of the README file. + +4.4) My FreeBSD box complains about 'Shared object "nss_dns.so.1" not found' + + We haven't figured out the exact cause yet, but as a quickfix you can + delete the /etc/nsswitch.conf file. Please keep in mind that removing a + configuration file can be dangerous, so only do this if you know what you + are doing. + +4.5) Anope and long (more then 30 character) nicknames. + + By default anope only supports nicknames up to 30 characters (NICKLEN=30). + If your IRCd allows for longer nicknames or has been modified to do so + anope will start logging a lot of ("NICK from nonexistent nick") messages. + This is because once a user uses a nick that is too long for anope to handle, + anope loses track of the user for the remainder of the session. + It is POSSIBLE but not NOT RECOMMENDED to extend the maximum length of nicknames + anope can track, however this will also break database compatibility. DBs saved + with anope set to allow for example 40 chars cannot be read by a default anope + and vice versa. So changing the maximum nick length is only possible + when starting with fresh databases and even then the consequences of this are + UNTESTED. + In order to change the maximum internal nick length, change the NICKMAX setting + in include/config.h, recompile anope and start without databases. + + +5) ChanServ + +5.1) Anope's channel mode setting doesn't work. I can't set modes with + OperServ, and every time ChanServ tries to set a mode, my server reverses + the change. + + Make sure EVERY server on your network has a U: line for Services in + ircd.conf, for example: + + U:services.whatever.net:*:* + +5.2) Anope ignored the SET SUCCESSOR setting and deleted a channel when the + founder expired. + + Normally, this is because the successor had too many channels registered; + in this case, you will see an entry in the log file like the following: + + [date] Successor (SuccessorNick) of channel #somechannel owns too many + channels, deleting channel #somechannel + + If you don't get a message like this or you can verify that the successor + wasn't running into the channel limit, please report it using the + bug-reporting procedure below (see section 6 of the README file). + +5.3) How to auto voice all those whom join my #channel? + + Execute the following commands (/cs is an alias for /msg ChanServ): + + /cs set #channel secure off + /cs set #channel xop off + /cs levels #channel set AUTOVOICE -1 + +5.4) Channel options like RESTRICTED or SECUREOPS don't work. What's wrong? + + Make sure that you didn't put any of your normal IRCd's as a ULined server + in Anope. Some access checks for clients from ULined servers are skipped to + avoid fights between the ULined servers. This is usually only useful when + you have a statistics server connected to your network. + + +6) BotServ + +6.1) How do I add bots to BotServ? + + Read /msg BotServ HELP and /msg BotServ HELP BOT. Note that you need to be + opered up and identified as a Services Administrator before you can use the + BOT command. + +6.2) Why do kick triggers and fantasy commands fail to work with my Bahamut + IRCd? + + Bahamut allows you to setup a server as 'serviceshub'. This will filter + certain data services usually don't need to process. This option also + filters channel messages, because DALnet's services have no use for them. + Anope parses the channel messages for kick triggers and fantasy commands. + To make sure these work the server type of the hub they're linked to should + be simply 'hub' and not 'serviceshub'. + + +7) Language + +7.1) Anope complains in the logfile about being unable to load the default + language. + + You forgot to run "make install". + +7.2) Anope spricht kein Deutsch!, etc. (Anope doesn't speak my language!) + + See section 5 of the README file. + +7.3) I selected a language other than English, but sometimes Anope sends + responses in English instead. + + Some language files are not complete--in other words, they don't have a + translation of every message Anope uses, but only some of them. In this + case, the missing messages will be displayed in English. You can either + wait for the primary translator to provide us with a translation, or do the + translation yourself and send us the messages translated into your + language. + + +8) DevNull + +8.1) What is the purpose of DevNull? + + DevNull functions as a message sink. Any message sent to it will be + ignored. It will not be logged, there will be no response. It will be lost + forever. Whether it's useful or not is up to you; we just provide you with + the option. diff --git a/docs/INSTALL b/docs/INSTALL new file mode 100644 index 000000000..33e62f346 --- /dev/null +++ b/docs/INSTALL @@ -0,0 +1,184 @@ +Anope Installation Instructions +------------------------------- + +1) Installing Anope +2) Upgrading Anope +3) Setting up the IRCd +4) Starting Anope +5) Setting up a crontab + +Note: You should also read the README and FAQ files! + +1) Installing Anope + + IMPORTANT NOTE: it is not recommended to use (and therefore install) + Anope as root. Use an unprivileged user instead -- the + one you're using for the ircd or a dedicated one will + be good enough. + + The very first thing you need to do is to get the Anope package (if not + already done). You can find it at: + + http://www.anope.org/ + + Next, unpack the package in your home directory, and go into the created + directory. + + Now type ./Config to start the configuration script. It will ask you a + few questions, and figure out how to compile Anope on your system. If + you are unsure about the answer to a question, use the default value. + + NOTE: although you may specify different binary and data paths, it is + RECOMMENDED that you use the same value for both. + + You can now type make to compile Anope. If there are errors in the + Makefile, *try to use gmake* instead. If it still doesn't work, you (or + the system administrator if it's a shell) must install GNU make. You may + find it at ftp://prep.ai.mit.edu/pub/gnu/. + + Now type make install (or gmake install; see above). This will install + all the needed files in the paths you specified with the configure + script, and setup file permissions. You should ensure that the data + directory is not accessible by other users, as malicious users may + cause trouble on your network if passwords are not encrypted, or read + the memos of any user. + + If you see errors during this process, please mail us with the *complete* + error output, and don't forget to mention your OS, compiler and C library + versions. + + N