Welcome to the ModuleName Manual. This document will aid you in setting up and running ModuleName on your IRC network.
<add module introduction>
ModuleName is Copyright, 2005 by Justin Hammond.
ModuleName is designed to run on Top of NeoStats. The Following requirements at the time of writing are required for NeoStats:
A Linux or BSD based Server or Shell.
A IRCd supported by NeoStats. See the NeoStats website.
Some basic Unix administration Skill
Of Course, a IRC network to connect it all together.
Please refer to the NeoStats website for more information on the requirements
ModuleName itself requires the following:
NeoStats 3.0 or Higher correctly installed and Running
The time to read this entire document.
As long as you have successfully setup NeoStats, and installed it correctly, Compiling ModuleName is very simple and straight forward. First you must extract the files from the download package. This is as simple as:
bash$ tar -xzf ModuleName-<ver>.tar.gzThis should then create a directory called ModuleName-<version> where <version> is the Version of ModuleName. Then Proceed to Change into the ModuleName directory, and run Configure as follows:
bash$./configure [--enable-debug | --with-neostats=<dir>]--enable-debug is only useful for diagnostics purposes when used in conjunction with debugging tools. There should be no need to use this option on a day to day basis
--with-neostats=<dir> should be used if your neostats directory is not in a standard location (~/NeoStats/). Replace <dir> with the full path to your NeoStats installation directory (NOT SOURCE DIRECTORY)
Configuring ModuleName will look something like the following screen:
Fishs-Mac:~/Documents/Dev/ModuleName justin$ ./configure +ModuleName 3.0 Manual \ No newline at end of file +[13:22] -ModuleName- *.blah.com delete from exclusion listWelcome to the ModuleName Manual. This document will aid you in setting up and running ModuleName on your IRC network.
<add module introduction>
ModuleName is Copyright, 2006 by Justin Hammond.
ModuleName is designed to run on Top of NeoStats. The Following requirements at the time of writing are required for NeoStats:
A Linux or BSD based Server or Shell.
A IRCd supported by NeoStats. See the NeoStats website.
Some basic Unix administration Skill
Of Course, a IRC network to connect it all together.
Please refer to the NeoStats website for more information on the requirements
ModuleName itself requires the following:
NeoStats 3.0 or Higher correctly installed and Running
The time to read this entire document.
As long as you have successfully setup NeoStats, and installed it correctly, Compiling ModuleName is very simple and straight forward. First you must extract the files from the download package. This is as simple as:
bash$ tar -xzf ModuleName-<ver>.tar.gzThis should then create a directory called ModuleName-<version> where <version> is the Version of ModuleName. Then Proceed to Change into the ModuleName directory, and run Configure as follows:
bash$./configure [--enable-debug | --with-neostats=<dir>]--enable-debug is only useful for diagnostics purposes when used in conjunction with debugging tools. There should be no need to use this option on a day to day basis
--with-neostats=<dir> should be used if your neostats directory is not in a standard location (~/NeoStats/). Replace <dir> with the full path to your NeoStats installation directory (NOT SOURCE DIRECTORY)
Configuring ModuleName will look something like the following screen:
Fishs-Mac:~/Documents/Dev/ModuleName justin$ ./configure checking whether to enable maintainer-specific portions of Makefiles... no checking for a BSD-compatible install... /usr/bin/install -c checking whether build environment is sane... yes @@ -46,4 +46,4 @@ Installing README.ModuleName.html: [OK]Deleting an Entry
To delete a entry, you should first lookup the Position of the entry that you wish to delete. The format of the command is as follows:
/msg ModuleName exclude del <pattern>Where:
<pattern> is the pattern of the entry you wish to delete in the list
The output of the command is as follows:
[13:22] ModuleName Fish used EXCLUDE -[13:22] -ModuleName- *.blah.com delete from exclusion listThat command forces ModuleName to check the Dat File version at http://secure.irc-chat.net/ and download the latest version if required.
Warning
Repeated use of this command in a short period of time will result in your account at secure.irc-chat.net being suspended for abuse. Use with CARE
The format of the command is as follows:
/msg ModuleName update
That command forces ModuleName to check the Dat File version at http://secure.irc-chat.net/ and download the latest version if required.
Repeated use of this command in a short period of time will result in your account at secure.irc-chat.net being suspended for abuse. Use with CARE
The format of the command is as follows:
/msg ModuleName update