summaryrefslogtreecommitdiff
path: root/docs/MODULES
diff options
context:
space:
mode:
authorgeniusdex geniusdex@31f1291d-b8d6-0310-a050-a5561fc1590b <geniusdex geniusdex@31f1291d-b8d6-0310-a050-a5561fc1590b@5417fbe8-f217-4b02-8779-1006273d7864>2005-02-21 17:12:47 +0000
committergeniusdex geniusdex@31f1291d-b8d6-0310-a050-a5561fc1590b <geniusdex geniusdex@31f1291d-b8d6-0310-a050-a5561fc1590b@5417fbe8-f217-4b02-8779-1006273d7864>2005-02-21 17:12:47 +0000
commit984677b5a41ae90da7cde78a0ed577df9c293977 (patch)
treef4145ad894191be938eb55af505cba7e4aff1656 /docs/MODULES
parent1ee7364fb32fb7e1214f4e51562878faf287d029 (diff)
BUILD : 1.7.8 (578) BUGS : NOTES : Updates of documentation (BUGS, IRCD, EVENTS, MYSQL, INSTALL, MODULES, DEFCON) for one style and some smaller fixes and updates.
git-svn-id: svn://svn.anope.org/anope/trunk@578 31f1291d-b8d6-0310-a050-a5561fc1590b git-svn-id: http://anope.svn.sourceforge.net/svnroot/anope/trunk@428 5417fbe8-f217-4b02-8779-1006273d7864
Diffstat (limited to 'docs/MODULES')
-rw-r--r--docs/MODULES50
1 files changed, 28 insertions, 22 deletions
diff --git a/docs/MODULES b/docs/MODULES
index af2cd376d..85fb283d5 100644
--- a/docs/MODULES
+++ b/docs/MODULES
@@ -1,35 +1,42 @@
Anope Modules
-------------
-Introduction:
+1) Introduction
+2) Installation
+3) Usage
+4) Usage Example
+5) More Modules
+6) Support
+7) Information for Developers
- Anope 1.6 onwards supports external modules. External modules are pieces
- of code that can be attached to a running Anope process dynamically. These
- modules can serve several purposes, and perform all kind of operations to
- enhance your network.
+1) Introduction
-Installation:
+ Anope 1.6 onwards supports external modules. External modules are pieces
+ of code that can be attached to a running Anope process dynamically. These
+ modules can serve several purposes, and perform all kind of operations to
+ enhance your network.
+
+2) Installation
1. If modules are supported by your system, they will be configured
automatically when you run ./Config. The modules will be installed
to the modules directory in your data path (by default this will
be ~/services/modules).
- Notes:
-
- * Modules are not supported on the following platforms: OpenBSD, Windows.
- * You might need to run "make distclean" prior to running ./Config
+ Note: you might need to run "make distclean" prior to running ./Config
2. Compile Anope as usual. The (g)make process will now compile module
support into Anope, and compile the default sample modules, and/or
- any other module located on the "modules" folder.
+ any other module located on the modules folder ("src/modules/").
3. Install Anope as usual. The install process will place the compiled
modules in their runtime location, making them available for loading.
4. Start or restart services to make use of the new Anope executable.
+ Note that you do not need to restart to load new or changed modules,
+ only to make use of a new Anope executable.
-Usage:
+3) Usage
All module manipulation commands are done through OperServ. These are:
@@ -45,7 +52,7 @@ Usage:
of "ModuleAutoload" and "ModuleDelayedAutoload" to include the modules
you want to load every time Anope starts.
-Example:
+4) Usage Example
/msg OperServ modload hs_moo
*** Global -- from OperServ: dengel loaded module hs_moo
@@ -70,28 +77,27 @@ Example:
modules have an abbreviated service name they attach to (hs_ for
HostServ, cs_ for ChanServ, etc) followed by a descriptive keyword.
-More Modules:
+5) More Modules
Anope ships with two sample modules that only illustrates some of the
implemented module capabilities. They don't really do much or anything
useful.
- You can download more useful modules from http://www.anope.org/ or from
- our interim modules development website http://modules.anope.org/. Just
+ You can download more useful modules from http://modules.anope.org/. Just
grab the module file (usually with a .c extension). Place the module
- file on your compile "src/modules" folder. The same folder that contain both
- hs_moo.c and catserv.c module files.
+ file in your modules (src/modules) folder; the same folder that contains
+ both hs_moo.c and catserv.c module files.
The new modules need to be compiled and installed before you can make
use of them:
- 1. Make sure you're in the main source directory.
+ 1. Make sure you're in the main source directory. (usually anope-1.X.XX/)
2. Run `make modules` to compile any new or changed modules.
3. Run `make install` to install the modules.
You can now use /msg OperServ MODLOAD to load the new modules.
-Support:
+6) Support
The Anope team is not responsible or liable for any unofficial module
(i.e. anything other than what was released with the Anope package).
@@ -101,9 +107,9 @@ Support:
author, posting on our online forum, or maybe on our #anope channel
at /server irc.anope.org.
-Developers:
+7) Information for Developers
Please take a look at:
- * http://geniusdex.dezeserver.nl/anope
+ * http://geniusdex.dezeserver.nl/anope-wiki/