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.gz

This 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
checking for gawk... no
checking for mawk... no
checking for nawk... no

<snip>

checking To Enable AutoTools Debug Mode?... no
checking silent building of source files... Enabled
configure: creating ./config.status
config.status: creating Makefile
config.status: creating modconfig.h
config.status: modconfig.h is unchanged
config.status: executing depfiles commands
Configuration complete.
Press Enter key to read the release notes

The Configure process will then prompt you to read the release notes. You are encouraged to read this document throughly as it might contain important information about the current version of ModuleName that isn't covered in the manual.

If the configuration did not produce a error, you may then move onto Compiling ModuleName. Compiling is simply just issuing the "make" command (or "gmake" if you are running BSD):

Fishs-Mac:~/Documents/Dev/ModuleName justin$ make
make -s all-am
Compiling Helpers.c:                                                  [OK]     
Compiling ModuleName.c:                                               [OK]     
Compiling scan.c:                                                     [OK]     
Compiling OnJoinBot.c:                                                [OK]     
Compiling ModuleName_help.c:                                          [OK]     
Compiling update.c:                                                   [OK] 

Again, check for Error messages. As long as there are not error messages, "make install" will install ModuleName, this README file, and any auxiliary files needed into your NeoStats directory:

Fishs-Mac:~/Documents/Dev/ModuleName justin$ make install
Installing ModuleName.so:                                             [OK]     
Installing viri.dat:                                                  [OK]     
Installing README.ModuleName:                                         [OK]     
Installing README.ModuleName.html:                                    [OK] 

If you receive *ANY* errors at all during the this process, please post them on our Support boards, at http//www.neostats.net/boards/

Once Installation is complete, you can either configure NeoStats to load ModuleName when it starts, or load ModuleName via IRC.

To Configure NeoStats to automatically load ModuleName when it boots, modify the neostats.conf file and add ModuleName to the list of modules to load:

MODULENAME = {
       "statserv",
       "hostserv",
       "ModuleName",
} 

To load ModuleName via IRC, you must make sure you have the appropriate permissions and issue the following command:

/msg neostats load ModuleName

Thats it. ModuleName is now loaded and ready for use (in fact, it will already be running now, but read on for further information.)

Blah Blah

BLAH BLAH

This setting allows you to change the Nickname that ModuleName uses when it connects to your network. If you change this setting make sure you update your NeoNet account, otherwise you might loose access to the Secure IRC-Chat site if we perform a check on your network and can't find "ModuleName" running.

/msg ModuleName set NICK <nickname>

This setting allows you to set a "Backup" nickname used for ModuleName. If the primary Nickname in the NICK Setting is not available, ModuleName will use this nickname, and if that is not available, it will use a automatically generated nickname

/msg ModuleName set ALTNICK <nickname>

This option allows you to customize the "user" or ident portion of the ModuleName Bot.

/msg ModuleName set USER <user>

This option allows you to customize the Hostname that ModuleName uses when it signs onto your Network. It defaults to the Standard Hostname specified in your NeoStats configuration.

/msg ModuleName set HOST <host>

This option allows you to customize the realname (or Gecos) that ModuleName uses when it signs onto your Network.

/msg ModuleName set REALNAME <realname>

This option enables ModuleName to use the Global Exclusions list that is control by the main NeoStats bot. This allows you to maintain a "global" exclusion list that is applicable to all modules in NeoStats, and then only apply individual exclusions to ModuleName.

If you wish to enable or disable the Global Exclusions lists, issue the following command

/msg ModuleName set EXCLUSIONS <ON/OFF>

blah blah description

To Change the setting, issue the following Command:

/msg ModuleName set blahblah <blah> 

The help command allows the users to access the online help for the different commands available. You can get general help about the available commands, or can access more specific information about a command.

To see the help pages, use the following format:

/msg ModuleName help [command]

command is optional and only required if you want more specific information about a particular command

This command displays the Version of ModuleName, and the dat files.

The format of the command is as follows:

/msg ModuleName version

The about command shows a brief description of the Bot and its purpose.

The format of the command is as follows:

/msg ModuleName about

The credits command shows details about the authors or contributors of to the Module

The format of the command is as follows:

/msg ModuleName credits

The levels command allows you to adjust the security of each command available in this module. You can make certian commands only available to higher "level" users in NeoStats.

For more information about NeoStats Levels and Security, please consult the NeoStats Manual

To list the currently configured levels, issue the following command:

/msg ModuleName levels list

To change the minimum level required to execute a command, issue the following command:

/msg ModuleName levels <command> <level>

Where:

command = is the actual command name you wish to modify

level = a number between 0 and 200 that specifies the new level.

The set command allows you to modify settings applicable to this module. For a complete description of the available set options, please consult the Detailed Configuration Section of this manual.

Exclusion lists allow you to specify certain Hostmasks, Servers, or Channels that should be excluded from monitoring by ModuleName. This exclusion list would allow a administrator to say, allow users on that are matched against Trojans, when the administrator has verified that the Trojan does not in fact exist on the users host.

With NeoStats 3.0, you should also be aware that there are two types of Exclusion Lists. There are "Global" exclusion lists that all modules may optionally use, and there is module specific exclusion lists. ModuleName defaults to not using the Global Exclusion lists. You can enable it by the following command:

/msg ModuleName set exclusions on

Adding a Entry

To add a entry to the Exclusion list, use the following format:

/msg ModuleName exclude add <host/Server/Channel/UserHost> <pattern> <reason>

Where:

<Host/Server/Channel/UserHost> = The type of exclusion you are adding. The different types are:

<pattern> = The pattern you wish to match on. May include wildcard charactors such as * and ?

<reason> = a short description of the exclusion, for operator reference only.

The output is as follows:

[13:20] -ModuleName- Added *.blah.com (userhost) to exclusion list
[13:20] ModuleName Fish added *.blah.com (userhost) to the exclusion list

Listing an Entry

To list the Exclusions simple type:

/msg ModuleName exclude list

And all the current exclusions are listed. Additionally, a Position number is provided for use with the delete command. The output is as follows:

[13:21]  -ModuleName- Exclusion list:
[13:21]  -ModuleName- #bothouse (Channel) Added by Fish on Sat Aug 13 2005 01:20 AM SGT for Requested
[13:21]  -ModuleName- #ircop (Channel) Added by Fish on Sat Aug 13 2005 07:40 PM SGT for IRCop channel
[13:21]  -ModuleName- *irc-chat.net (Host) Added by Fish on Tue Aug 09 2005 10:13 PM SGT for Services Exclusion
[13:21]  -ModuleName- chieftess!*@* (Userhost) Added by Fish on Tue Aug 09 2005 10:14 PM SGT for buggy client
[13:21]  -ModuleName- *.blah.com (Userhost) Added by Fish on Sun Jan 15 2006 01:20 PM SGT for Cause Blah.com is cool
[13:21]  -ModuleName- End of list.

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 list

That command forces ModuleName to check the Dat File version at http://secure.irc-chat.net/ and download the latest version if required.

The format of the command is as follows:

/msg ModuleName update

Subheading