Anope Stable Branch

git-svn-id: http://anope.svn.sourceforge.net/svnroot/anope/stable@1902 5417fbe8-f217-4b02-8779-1006273d7864

15 files changed, 4495 insertions, 0 deletions

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.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) 19yy  <name of author>
+
+    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.
+
+  <signature of Ty Coon>, 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 all