Manual for NeoStats


Table of Contents

1. Introduction To NeoStats
2. QuickStart Guide
3. Installing NeoStats
4. Using NeoStats & Supplied Modules
Purpose
General Usage
5. NeoStats
About NeoStats
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
LEVEL
STATUS
SHUTDOWN
RELOAD
LOAD
UNLOAD
MODLIST
RAW
JUPE
EXCLUDE
Debugging Command Reference
USERLIST
CHANNELLIST
SERVERLIST
BANLIST
BOTLIST
SOCKLIST
TIMERLIST
Settings Reference
CMDCHAR Setting
MSGTHRESHOLD Setting
MSGSAMPLETIME Setting
DEBUGCHAN Setting
ALLHELP Setting
REVCQ Setting
CMDREPORT Setting
SERVICEUMODE Setting
SENDHELP Setting
SPLITTIME Setting
LOGLEVEL Setting
SERVICECMODE Setting
JOINSERVICESCHAN Setting
PINGTIME Setting
Debugging Settings Reference
DEBUGTOCHAN Setting
DEBUGMODULE Setting
DEBUGLEVEL Setting
6. StatServ
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
CTCPVERSION
CHANNEL
SERVER
MAP
NETSTATS
DAILY
TLDMAP
OPERLIST
BOTLIST
FORCEHTML
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
RECORDALERT Setting
HTMLPATH Setting
HTMLTIME Setting
HTML Setting
CHANNELTIME Setting
MSGLIMIT Setting
MSGINTERVAL Setting
FLATMAP Setting
LAGTIME Setting
LAG Setting
HTML Template Syntax
7. ConnectServ
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
LOGGING Setting
KILLWATCH Setting
SERVWATCH Setting
NICKWATCH Setting
SIGNWATCH Setting
MODEWATCH Setting
AWAYWATCH Setting
COLOUR Setting
8. HostServ
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
ADD
DEL
LIST
VIEW
LOGIN
BANS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
VERBOSE Setting
HIDDENHOST Setting
HOSTNAME Setting
OPERHOST Setting
ADDLEVEL Setting
EXPIRE Setting
9. LimitServ
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
10. OperLog
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
11. QuoteServ
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
12. TextServ
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
13. ExtAuth
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
14. IRCDAuth
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
15. Writting Modules
16. Wirring Perl Modules
17. Writting C Modules: template
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting
18. Writting Authentication Modules: templateauth
Command Reference
HELP
VERSION
ABOUT
CREDITS
LEVELS
Settings Reference
NICK Setting
ALTNICK Setting
USER Setting
HOST Setting
REALNAME Setting
EXCLUSIONS Setting

Chapter 1. Introduction To NeoStats

Chapter 2. QuickStart Guide

Chapter 3. Installing NeoStats

Chapter 4. Using NeoStats & Supplied Modules

Table of Contents

Purpose
General Usage

Purpose

The rest of this document explains how to use NeoStats and the commands available for the various components.

For help on downloaded modules, refer to the documentation that comes with the module. Typically, after installation, the documentation for the downloaded modules in named "README.<modulename>"

Most NeoStats components include online help so you can find out how to use a command while on IRC. To access general online help for the Bot use:

/msg BotName HELP

To access online help for a given command use:

/msg BotName HELP COMMAND

General Usage

To send a command to a NeoStats module or bot you will always use the following from an IRC Client:

/msg botname command [options]

e.g.

/msg NeoStats SET

If you change the default name of a bot, you will need to change the command. If you decided to change the name of StatServ to StatBot, then you must use this name when entering commands: e.g.

/msg StatBot MAP

Commands are listed here in upper case to make reading this document easier. IRC is not case sensitive. This means that:

/msg StatServ MAP
/msg StatServ map
/msg statserv Map

will all perform the same task. Some commands of NeoStats and StatServ are available to all users as well as opers unless you specify ONLY_OPERS in neostats.cfg. Refer to README and neostats.cfg for more information on the ONLY_OPERS option. Command help in this document is broken into three sections:

Syntax: The syntax used for a command

Description: Description of the command and it's options

Example: Example of how to use the command

Optional parameters are presented between [] e.g. [reason]

Required parameters are presented between <> e.g. <reason> The | character indicates that only one of the option list can be used at any one time. e.g. option1|option2

When using the command, do not use the [],<> or | from the syntax.

Chapter 5. NeoStats

The following Section describe NeoStats, or the Core to these services

About NeoStats

NeoStats is the core component of NeoStats Services. It manages booting of the system, loading and unloading of modules and assignment of privilege levels to users. It can be considered much the same as what OperServ does for most services packages. It controls the actual software, but does not provide any functions to the users. Its intended to be used by the network administration only.

Command Reference

The Following are detailed Descriptions of the available commands:

HELP

Syntax:

/msg NeoStats HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Available to users if ONLY_OPERS not set in the configuration file

Example:

/msg NeoStats HELP 
/msg NeoStats HELP INFO

VERSION

Syntax:

/msg NeoStats version

Description:

Displays the current core version of NeoStats

Example:

/msg NeoStats VERSION

ABOUT

Syntax:

/msg NeoStats ABOUT

Description:

Shows a descriptive text about NeoStats

Example:

/msg NeoStats ABOUT

CREDITS

Syntax:

/msg NeoStats CREDITS

Description:

Shows details about the Authors and Contributors of NeoStats

Example:

/msg NeoStats CREDITS

LEVELS

Syntax:

/msg NeoStats LEVELS LIST
/msg NeoStats LEVELS <command> <newlevel>

Description:

Permissions in NeoStats are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg NeoStats LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg NeoStats LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

LEVEL

Syntax:

/msg NeoStats LEVEL <nick>

Description:

Allows you to see your permissions level with regards NeoStats. 0 is lowest, 200 is highest, you could be anywhere in between! If you specify a nickname, it allows you to check that users level as far as NeoStats is concerned.

Example:

/msg NeoStats LEVEL

STATUS

Syntax:

/msg NeoStats status

Description:

Allows you to check NeoStats's status, with information such as Uptime, NeoNet connection status, and user/server/channel/socket data, as well as brief Network Statistics.

Example:

/msg NeoStats LEVEL

SHUTDOWN

Syntax:

/msg NeoStats SHUTDOWN <reason>

Description:

Force NeoStats to exit immediately. This command should be used wisely.

Example:

/msg NeoStats SHUTDOWN upgrade

RELOAD

Syntax:

/msg NeoStats RELOAD <reason>

Description:

Force NeoStats to reload. This command will cause StatServ to split from the network, reload data files and connect. This command SHOULD be used wisely.

Note

This command is not available on Windows Builds of NeoStats

Example:

/msg NeoStats RELOAD Lagged

LOAD

Syntax:

/msg NeoStats LOAD <module>

Description:

Allows you to load a module while NeoStats is running. Some modules can not be loaded at runtime, and will return an error.

Example:

/msg NeoStats LOAD statserv

UNLOAD

Syntax:

/msg NeoStats UNLOAD <module>

Description:

Allows you to unload a module while NeoStats is running. Some modules can not be unloaded at runtime, and will return an error

Example:

/msg NeoStats UNLOAD statserv

MODLIST

Syntax:

/msg NeoStats MODLIST

Description:

Display module names and descriptions of loaded modules

Example:

/msg NeoStats MODLIST

RAW

Syntax:

/msg NeoStats RAW COMMAND

Description:

Allow you to send raw IRC commands from this server Nothing is returned to the user after a raw command It is recommended that you never use this command. It can cause desyncs and other problems. No support will be provided for use of this command.

Warning

Problems with RAW are NOT SUPPORTED.

Note

RAW is not enabled by Default in NeoStats. The availability of this command depends upon the installation. Please consult the installation guide for more info about enabling the Raw command.

Example:

/msg NeoStats RAW COMMAND

JUPE

Syntax:

/msg NeoStats JUPE Server

Description:

Allows you to jupe a server on the network

Example:

/msg NeoStats JUPE jupe.com

EXCLUDE

Syntax:

/msg NeoStats EXCLUDE LIST
/msg NeoStats EXCLUDE ADD <HOST/SERVER/CHANNEL/USERHOST> <pattern> <reason>

Description:

Exclusion Lists allow you to stop NeoStats acting on certian users, channels, servers, or hostname masks. This for example, allows you to stop NeoStats from interacting with your Services Server (NickServ etc) which is often advisable.

In NeoStats, there are two types of Exclusion Lists. One is a Global Exclusion List that applies to all Bots/Services loaded on NeoStats. The other type is a "Per Module" exclusion list that only applies to individual modules.

This Exclusion command maintains the global exclusion list here. Ideally, the only entries in this exclusion list should be for your Services Server, Bots that may not play nicely with NeoStats, or Abusive Users. If any user matches this exclusion list, they can not interact at all with NeoStats, or any of its modules.

Example:

/msg NeoStats EXCLUDE LIST

/msg NeoStats EXCLUDE ADD HOST *.microsoft.com Microsoft Employes are not welcome here!

/msg NeoStats EXCLUDE DEL *.microsoft.com

Debugging Command Reference

The following Commands can assist you or developers to Debug NeoStats

USERLIST

Syntax:

/msg NeoStats USERLIST [nick]

Description:

When in debug mode, Neostats will echo its user table to the services channel. Only useful for debugging Neostats

If nick is passed, only the information of that nick is returned, otherwise the entire user list is dumped.

Example:

/msg NeoStats USERLIST

CHANNELLIST

Syntax:

/msg NeoStats CHANNELLIST [channel]

Description:

When in debug mode, Neostats will echo its channel table to the services channel. Only useful for debugging Neostats If channel is passed, only the information of that channel is returned, otherwise the entire channel list is dumped.

Example:

/msg NeoStats CHANNELLIST

SERVERLIST

Syntax:

/msg NeoStats SERVERLIST

Description:

When in debug mode, Neostats will echo its server table to the services channel. Only useful for debugging Neostats

Example:

/msg NeoStats SERVERLIST

BANLIST

Syntax:

/msg NeoStats BANLIST

Description:

When in debug mode, Neostats will echo its network wide Ban List (AKILLS, GLINES etc) to the services channel. Only useful for debugging Neostats

Example:

/msg NeoStats BANLIST

BOTLIST

Syntax:

/msg NeoStats BOTLIST

Description: NeoStats will send you by notice a list of the current bots being used on the network for each module.

Example:

/msg NeoStats BOTLIST

SOCKLIST

Syntax:

/msg NeoStats SOCKLIST

Description

NeoStats will send you by notice a list of the current sockets being used on neostats for each module.

Example:

/msg NeoStats SOCKLIST

TIMERLIST

Syntax:

/msg NeoStats TIMERLIST

Description: NeoStats will send you by notice a list of the current timer functions being used on the network by each module.

Example:

/msg NeoStats TIMERLIST

Settings Reference

The Following Settings are configurable online with NeoStats. They help you customize NeoStats and its configuration to suit your network. Some settings affect all of NeoStats, while others only affect the NeoStats Root Bot ("NeoStats"). The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg NeoStats SET LIST

/msg NeoStats SET <option> <paramater>

The Following Settings are available in NeoStats:

CMDCHAR
MSGTHRESHOLD
MSGSAMPLETIME
DEBUGCHAN
ALLHELP
RECVQ
CMDREPORT
SERVICEUMODE
SENDHELP
SPLITTIME
LOGLEVEL
SERVICECMODE
JOINSERVICESCHAN
PINGTIME

CMDCHAR Setting

This setting is to customize what charactor will be used for commands that are activated via Channel Messages. By default, it is set to "!" which means to trigger a command in a channel, a user must type !<command>

Note

This setting affects all NeoStats Bots

This setting defaults to !

MSGTHRESHOLD Setting

NeoStats has inbuilt flood protection. This setting defines how many messages NeoStats will allow in MSGSAMPLETIME (see below) before ignoring or killing a user.

Note

Operators are exempt from FloodProtection

Note

This setting affects all NeoStats Bots

This setting defaults to 5 messages (in 30 Seconds, by default for MSGSAMPLETIME)

MSGSAMPLETIME Setting

This setting defines how long NeoStats will calculate if a user is flooding NeoStats (or its bots). If NeoStats recieves MSGTHRESHOLD messages in MSGSAMPLETIME, the user will be killed or ignored.

Note

This setting affects all NeoStats Bots

This setting defaults to 30 seconds

DEBUGCHAN Setting

NeoStats can send debugging information to a channel if it has been built with Debugging Enabled. This option sets which channel to output that debuging information. See the other DEBUG options listed below for information on how to customize the Debugging Information.

Note

This setting affects all NeoStats Bots

This setting defaults to #DEBUG

ALLHELP Setting

Some NeoStats bots might have different commands that are triggered via either Channel Messages or Private Messages. For bots that use both Channel Messages or Private Messages, this option allows you to configure the help messages sent to a user. If the User triggers help via a Channel Message, and this setting is Off, then only commands that can be triggered via Channel Messages will be displayed in Help. If the help command is used via a Private Message and this setting is off, then only commands that are available via Private Message are displayed. If you enable this setting then regardless of how a user requests help, then all commands are shown.

This setting defaults to disabled.

Note

This setting affects all NeoStats Bots

REVCQ Setting

Some NeoStats Modules connect to various Network resources (eg, DCC, NeoNet). This option specifies how big a buffer is made in the network code for this communication. If the amount of incomming traffic exceeds this amount, the network connection is disconnected.

Note

Not all network communications are affected by this setting. Consult the developers if you wish to know which modules might use this settting.

Warning

Changing this setting is not recommended unless you know what you are doing!

This setting defaults to 2048 Bytes.

CMDREPORT Setting

NeoStats can optionally echo commands used by users on all bots to the Services Channel. This allows members of the services channel to see what commands are being used by Users.

Note

This setting affects all NeoStats Bots

This setting defaults to Enabled.

SERVICEUMODE Setting

This is the default User Mode assigned to all NeoStats bots. It allows you to customize how the NeoStats Bots appear to end users.

Note

This setting affects most NeoStats Bots. Some Bots do not use this setting and may use a "per module" setting instead.

This setting defaults are dependant on the IRCd you connect to.

SENDHELP Setting

This setting controls if NeoStats should send the helptext associated with a command if the user specifies a invalid syntax or not. With this option disabled, Users only get a "Invalid Syntax Message", and with it enabled, they get the "Invalid Syntax" Message, plus the help associated with that command.

Note

This setting affects all NeoStats Bots

This setting defaults to enabled

SPLITTIME Setting

This setting controls determs the threshold that is used when calculating if a user is part of a NetJoin (when two servers link to the network) or if they are a brand new user. If they are considered to be "riding a netjoin", then certian actions may be ignored for a user (such as OPSB scanning these users for Open Proxies). SPLITTIME requires that all clocks on the Network Servers are closely in sync. Its not advised to Change this setting unless you know what you are doing.

A user is considered NetRiding if their Network Join Time is older than the current time minus the SPLITTIME seconds.

Note

This setting affects all NeoStats Bots

Note

This option might be ignored on some IRCd's that support network wide "End Of Burst" messages. Consult the IRCd specific information for details of which IRCd's support that currently.

This setting defaults to 300 Seconds

LOGLEVEL Setting

This setting controls how much debugging information is written to the LogFiles. Valid range is from 1 to 10. Debug Logging is only activated if debug mode is activated.

Note

This setting affects all NeoStats Bots

This setting defaults to 5 Seconds

SERVICECMODE Setting

This setting determines what channel modes NeoStats Bots will get when joining channels.

Note

This setting affects most NeoStats Bots. Those modules that don't use this setting will have individual settings.

This setting is dependant on the IRCd being used.

JOINSERVICESCHAN Setting

This setting determins if all NeoStats Bots should automatically join the Services Channel.

Note

This setting affects all NeoStats Bots

This setting defaults to enabled.

PINGTIME Setting

This setting determins how often NeoStats should ping the Uplink Server. This helps avoid "Ping Timeout" disconnections on small networks. It should be set less than the PingTime configuration on the IRCd you are connecting to.

This setting defaults to 120 seconds.

Debugging Settings Reference

The following settings can assist you or developers to Debug NeoStats

DEBUGTOCHAN Setting

This setting determines if Debugging information should be output to the Debug Channel Specified in teh DEBUGCHAN setting as well as outputing to the Log Files.

DEBUGMODULE Setting

Filter the messages output to the debug channel by module. Eg, you can specify that you only want debug messages for SecureServ.

DEBUGLEVEL Setting

What level of Debugging should be used.

Chapter 6. StatServ

StatServ provides statistical services to the network such as user, oper, server counts and uptime. It can also echo this information to a web page of your choice.

Command Reference

The following Commands may be used with StatServ.

HELP

Syntax:

/msg StatServ HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg StatServ HELP 
/msg StatServ HELP INFO

VERSION

Syntax:

/msg StatServ version

Description:

Displays the current version of StatServ

Example:

/msg StatServ VERSION

ABOUT

Syntax:

/msg StatServ ABOUT

Description:

Shows a descriptive text about StatServ

Example:

/msg StatServ ABOUT

CREDITS

Syntax:

/msg StatServ CREDITS

Description:

Shows details about the Authors and Contributors of StatServ

Example:

/msg StatServ CREDITS

LEVELS

Syntax:

/msg StatServ LEVELS LIST
/msg StatServ LEVELS <command> <newlevel>

Description:

Permissions in StatServ are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg StatServ LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg StatServ LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

CTCPVERSION

Syntax:

/msg StatServ CTCPVERSION <limit> 

Description:

Provides Statistics on the Client Versions found

<limit> Specifies how many results to show. Results are sorted by Most Popular to Least Popular

Example:

/msg StatServ CTCPVERSION

CHANNEL

Syntax:

/msg StatServ CHANNEL <POP/KICKS/TOPICS/<Channame>>

Description:

Provides Statistics on Channels on the network

CHAN

By itself provides a list of the top10 Channels based on the current number of members

CHAN POP

gives you information on the most popular channels on the network based on the number of joins

CHAN KICKS

Gives you the top 10 kicking channels

CHAN TOPICS

Gives you the top10 Topic Changing Channels

CHAN <name>

Gives you specific information on a channel

Example:

/msg statserv chan #neostats

SERVER

Syntax:

/msg StatServ SERVER <<server name>/LIST/DEL/RENAME> <oldserver> <newserver>

Description:

Allows you to view and modify server statistics.

SERVER <servername>

Allows you to view statistics about a particular server

SERVER LIST

Shows all the server entries stored in StatServ's Database.

SERVER DEL

Delete a server entry stored in StatServ's Database.

SERVER RENAME <oldserver> <newserver>

Rename a server entry stored in StatServ's Database.

Example:

/msg statserv server rollergirl.sg.as.irc-chat.net

MAP

Syntax:

/msg StatServ MAP

Description:

Provides a server listing with minimal statistics.

Example:

/msg StatServ MAP

NETSTATS

Syntax:

/msg StatServ NETSTATS

Description

Provides information about the performance of the network.

Example:

/msg StatServ NETSTATS

DAILY

Syntax:

/msg StatServ DAILY 

Description:

Provides information about records that have been set today.

Example:

/msg StatServ DAILY

TLDMAP

Syntax:

/msg StatServ TLDMAP 

Description:

Shows the network map in relation to top level domains.

Example:

/msg StatServ TLDMAP

OPERLIST

Syntax:

/msg StatServ OPERLIST <NOAWAY/<server_name>> 

Description:

Shows a listing of IRCops.

Flags:

NOAWAY

Don't show opers that are set away.

SERVER

Only show opers on that server.

Example:

/msg statserv operlist 
/msg statserv operlist noaway 
/msg statserv operlist <server>

BOTLIST

Syntax:

/msg StatServ BOTLIST 

Description:

Shows all current bots on the network. (umode +B users if your IRCD supports Umode +B)

Example:

/msg StatServ BOTLIST

FORCEHTML

Syntax:

/msg StatServ FORCEHTML 

Description:

Forces an update of the HTML data file with the most current network statistics.

Example:

/msg StatServ FORCEHTML

Settings Reference

The Following Settings are configurable online with StatServ. They help you customize StatServ and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg StatServ SET LIST

/msg StatServ SET <option> <paramater>

The Following Settings are available in StatServ:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
RECORDALERT
HTMLPATH
HTMLTIME
HTML 
CHANNELTIME
MSGLIMIT
MSGINTERVAL
FLATMAP
LAGTIME
LAGALERT

NICK Setting

This setting is to change the nickname that the StatServ module uses for the Bot.

This setting defaults to "StatServ"

ALTNICK Setting

This setting is to change the nickname that the StatServ module uses for the Bot if the Primary Nickname is not available

This setting defaults to "StatServ1"

USER Setting

The "User" that the StatServ bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that StatServ will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that StatServ will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if StatServ should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

RECORDALERT Setting

This setting determines if StatServ should broadcast new records on the network (such as Max no of users etc). The options are:

0 - Never

1 - Announce in services channel

2 - Announce by globops

3 - Announce by wallops

This setting defaults to 1 - Announce in services channel

HTMLPATH Setting

For StatServ to produce a HTML page with various statistics about your network, it needs to write a file. This setting specifies where to write the file to.

Warning

You must ensure that the user that NeoStats runs as has permissions to write to the path you specify. The path should also include the filename. eg:

/home/fish/public_html/networkstats.html

HTMLTIME Setting

How often StatServ should update the HTML file specified in HTMLPATH if HTML is enabled (See HTML setting)

This defaults to 3600 seconds

HTML Setting

Should StatServ automatically update the HTML file.

This defaults to Disabled

CHANNELTIME Setting

The amount of time that StatServ keeps statistics for unused channels in its Database. If a channel has not be active on the network for longer than this period, StatServ deletes it from the database.

This setting defaults to 604800 Seconds

MSGLIMIT Setting

This setting in conjuction with the below setting (MSGINTERVAL) helps StatServ avoid flooding the network with record annoucements. This option specifies how many messages to broadcast in MSGINTERVAL time below.

This setting defaults to 5

MSGINTERVAL Setting

This setting in conjunction with the above setting (MSGLIMIT) helps StatServ avoid flooding the network with record announcements. This option specifies how much time must elapse during before the MSGLIMIT counter is reset.

This setting defaults to 60 Seconds

FLATMAP Setting

This option causes the MAP command to become flat, thus not showing the real structure of your IRC network to users.

This setting defaults to disabled.

LAGTIME Setting

This settting determines how lagged a server should be for StatServ to consider that server lagged out.

LAG Setting

This setting determins if StatServ should broadcast a message when a servers pingtime exceeds the LAGTIME specified above.

Options are:

0 - Never

1 - Announce in services channel

2 - Announce by globops

3 - Announce by wallops

This setting defaults to 1 - Announce in services channel

HTML Template Syntax

By Default, StatServ uses a file called index.tpl in your data directory as the template for your output. Currently, the template system is very basic, and will output tables containing the information requested. All Template variables are enclosed by !

The available template variables are:

!MAP! -Outputs a network

Map similar to /msg statserv map in a table format

!SRVLIST! -Outputs a complete list of servers that StatServ has ever seen, which are linked to detailed server information provided by the template variable !SRVLISTDET!

!SRVLISTDET! -Outputs detailed server information

see also !SRVLIST!

!NETSTATS! -Outputs Network Statistics

similar to /msg statserv netstats

!DAILYSTATS! -Outputs the Daily Statistics

similar to /msg statserv daily

!DAILYTOPCHAN! -Outputs the top10 channels based on number of members

!TOP10CHAN! -Outputs the top10 channels ever based on number of joins

!TOP10KICKS! -Outputs the top10 kicking channels

!TOP10TOPICS! -Outputs the top10 topic changing channels

!TLDMAP! -Outputs the TLD map

similar to /msg statserv tldmap

!VERSION! -Outputs the version of NeoStats

!TITLE! -Outputs title in the form: "Network Statistics for YourNetName"

!CLIENTSTATS! -Outputs Top 10 clients used on the network. (Requires SecureServ module with version checks enabled).

StatServ also puts out some information on when the page was created, and what software created it by default at the end of your HTML page. This option can not be disabled. (Sorry, but its our little advertisement for all the hard work we have done to create NeoStats for you to use!)

An example template is provided for you so you don't have to waste time getting your own template ready. If you wish to create your own template, replace the index.tpl file in the data directory with your version.

Chapter 7. ConnectServ

ConnectServ is designed to echo the signing on/off of users killing of users, modes that the operators are using and nickname changes. These echo types can be customised to be echoed to the services channel or NOT to be echoed at all.

Command Reference

The following Commands may be used with ConnectServ.

HELP

Syntax:

/msg ConnectServ HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg ConnectServ HELP 
/msg ConnectServ HELP INFO

VERSION

Syntax:

/msg ConnectServ version

Description:

Displays the current version of ConnectServ

Example:

/msg ConnectServ VERSION

ABOUT

Syntax:

/msg ConnectServ ABOUT

Description:

Shows a descriptive text about ConnectServ

Example:

/msg ConnectServ ABOUT

CREDITS

Syntax:

/msg ConnectServ CREDITS

Description:

Shows details about the Authors and Contributors of ConnectServ

Example:

/msg ConnectServ CREDITS

LEVELS

Syntax:

/msg ConnectServ LEVELS LIST
/msg ConnectServ LEVELS <command> <newlevel>

Description:

Permissions in ConnectServ are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg ConnectServ LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg ConnectServ LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with ConnectServ. They help you customize ConnectServ and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg ConnectServ SET LIST

/msg ConnectServ SET <option> <paramater>

The Following Settings are available in ConnectServ:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
LOGGING
KILLWATCH
SERVWATCH
NICKWATCH
SIGNWATCH
MODEWATCH
AWAYWATCH
COLOUR

NICK Setting

This setting is to change the nickname that the ConnectServ module uses for the Bot.

This setting defaults to "ConnectServ"

ALTNICK Setting

This setting is to change the nickname that the ConnectServ module uses for the Bot if the Primary Nickname is not available

This setting defaults to "ConnectServ1"

USER Setting

The "User" that the ConnectServ bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that ConnectServ will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that ConnectServ will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if ConnectServ should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

LOGGING Setting

This setting determins if ConnectServ should also log all notices to the LogFile in addition to the services channel.

This setting defaults to Enabled.

KILLWATCH Setting

Should ConnnectServ broadcast out Global Kills on the network.

This setting defaults to Enabled.

SERVWATCH Setting

Should ConnectServ broadcast out Server Joins and Splits on the network

This defaults to Enabled.

NICKWATCH Setting

Should ConnectServ broadcast out Nickname Changes on the network

This defaults to Enabled

SIGNWATCH Setting

Should ConnectServ broadcast out Users connecting and disconnnecting on the network

This setting defaults to Enabled.

MODEWATCH Setting

Should ConnectServ broadcast out User Mode Changes on the network

This setting defaults to Enabled

AWAYWATCH Setting

Should ConnectServ broadcast out Users going away and comming back on the network

This setting defaults to Enabled

COLOUR Setting

Should the messages logged to the channel be in colour or standard.

This setting defaults to disabled.

Chapter 8. HostServ

HostServ is designed to let users use their own unique host while on the Network. IRC Operators add them to the database and upon connection the user gets their unique host. It also allows operators to set Undernet Style Hidden hosts for registered users.

Command Reference

The following Commands may be used with HostServ.

HELP

Syntax:

/msg HostServ HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg HostServ HELP 
/msg HostServ HELP INFO

VERSION

Syntax:

/msg HostServ version

Description:

Displays the current version of HostServ

Example:

/msg HostServ VERSION

ABOUT

Syntax:

/msg HostServ ABOUT

Description:

Shows a descriptive text about HostServ

Example:

/msg HostServ ABOUT

CREDITS

Syntax:

/msg HostServ CREDITS

Description:

Shows details about the Authors and Contributors of HostServ

Example:

/msg HostServ CREDITS

LEVELS

Syntax:

/msg HostServ LEVELS LIST
/msg HostServ LEVELS <command> <newlevel>

Description:

Permissions in HostServ are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg HostServ LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg HostServ LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

ADD

Syntax:

/msg HostServ ADD <NICK> <HOST NAME> <VIRTUAL HOST NAME> <PASSWORD>

Description:

Adds a entry to the HostServ Database for a specified User.

Example:

/msg HostServ ADD neo aol.com coolhost.com mypassword

DEL

Syntax:

/msg HostServ DEL <ACCESS LIST #>

Description:

Deletes a VHOST entry from the HostServ Database. <ACCESS LIST #> can be obtained by using the LIST command.

Example:

/msg HostServ DEL 1

LIST

Syntax:

/msg HostServ LIST <start>

Description:

Lists the people and vhosts in the Database. Only lists a maxium of 20 entries if <start> is specified, start the listing at number <start>

Example:

/msg HostServ LIST

VIEW

Syntax:

/msg HostServ VIEW <ACCESS LIST #>

Description:

View Detailed information about the vhost on the list # you selected

Example:

/msg HostServ VIEW 1

LOGIN

Syntax:

/msg HostServ LOGIN <NICK> <PASSWORD>

Description:

Login to HostServ with your NICK and PASSWORD and your vhost will be assigned to your nick on successful login.

Example:

/msg HostServ LOGIN Angel Password

BANS

Syntax:

/msg HostServ BANS [[add/del] <option>]

Description:

Controls the vhost banned list entries:

BANS lists current vhosts that are banned by network administration.

The following options are only available to Network Administration:

BANS add <wildcard> Add a banned vhost to the list Wildcards, like *fbi* are permitted.

BANS del # Delete a banned vhost with ID number #

You may figure out the ID number by using BANS by itself

Example:

/msg HostServ BANS add microsoft.com

Settings Reference

The Following Settings are configurable online with HostServ. They help you customize HostServ and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg HostServ SET LIST

/msg HostServ SET <option> <paramater>

The Following Settings are available in HostServ:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
VERBOSE
HIDDENHOST
HOSTNAME
OPERHOSTS
ADDLEVEL 
EXPIRE

NICK Setting

This setting is to change the nickname that the HostServ module uses for the Bot.

This setting defaults to "HostServ"

ALTNICK Setting

This setting is to change the nickname that the HostServ module uses for the Bot if the Primary Nickname is not available

This setting defaults to "HostServ1"

USER Setting

The "User" that the HostServ bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that HostServ will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that HostServ will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if HostServ should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

VERBOSE Setting

This setting determins if HostServ should broadcast all actions that HostServ performs, such as setting users VHOSTS etc.

This setting defaults to Enabled.

HIDDENHOST Setting

Should HostServ set a Undernet style hidden hosts for all users when they authenticate to NickServ (Recieve Umode +r). Undernet style hidden hosts are of the form <user>.user.HOSTNAME

This setting defaults to Disabled.

HOSTNAME Setting

Determines the Domain Name to use when setting users Hosts or Opers Hosts if HiddenHost or OperHost is enabled.

This has no default

OPERHOST Setting

Should HostServ set a Undernet style hidden hosts for all Operators when they authenticate to NickServ (Recieve Umode +r). Undernet style hidden hosts are of the form <user>.oper.HOSTNAME

This defaults to Disabled

ADDLEVEL Setting

The Level that is required to use the Add Command to create new VHOSTS for other users.

This setting defaults to 40

EXPIRE Setting

Should HostServ expire un-used entries after a period of time. Setting is specified as Days. if 0 is specified, makes all VHOSTS permanent

This setting defaults to 60 Days

Chapter 9. LimitServ

LimitServ is designed to ....

Command Reference

The following Commands may be used with LimitServ.

HELP

Syntax:

/msg LimitServ HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg LimitServ HELP 
/msg LimitServ HELP INFO

VERSION

Syntax:

/msg LimitServ version

Description:

Displays the current version of LimitServ

Example:

/msg LimitServ VERSION

ABOUT

Syntax:

/msg LimitServ ABOUT

Description:

Shows a descriptive text about LimitServ

Example:

/msg LimitServ ABOUT

CREDITS

Syntax:

/msg LimitServ CREDITS

Description:

Shows details about the Authors and Contributors of LimitServ

Example:

/msg LimitServ CREDITS

LEVELS

Syntax:

/msg LimitServ LEVELS LIST
/msg LimitServ LEVELS <command> <newlevel>

Description:

Permissions in LimitServ are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg LimitServ LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg LimitServ LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with LimitServ. They help you customize LimitServ and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg LimitServ SET LIST

/msg LimitServ SET <option> <paramater>

The Following Settings are available in LimitServ:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS

NICK Setting

This setting is to change the nickname that the LimitServ module uses for the Bot.

This setting defaults to "LimitServ"

ALTNICK Setting

This setting is to change the nickname that the LimitServ module uses for the Bot if the Primary Nickname is not available

This setting defaults to "LimitServ1"

USER Setting

The "User" that the LimitServ bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that LimitServ will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that LimitServ will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if LimitServ should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

Chapter 10. OperLog

OperLog is designed to ....

Command Reference

The following Commands may be used with OperLog.

HELP

Syntax:

/msg OperLog HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg OperLog HELP 
/msg OperLog HELP INFO

VERSION

Syntax:

/msg OperLog version

Description:

Displays the current version of OperLog

Example:

/msg OperLog VERSION

ABOUT

Syntax:

/msg OperLog ABOUT

Description:

Shows a descriptive text about OperLog

Example:

/msg OperLog ABOUT

CREDITS

Syntax:

/msg OperLog CREDITS

Description:

Shows details about the Authors and Contributors of OperLog

Example:

/msg OperLog CREDITS

LEVELS

Syntax:

/msg OperLog LEVELS LIST
/msg OperLog LEVELS <command> <newlevel>

Description:

Permissions in OperLog are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg OperLog LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg OperLog LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with OperLog. They help you customize OperLog and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg OperLog SET LIST

/msg OperLog SET <option> <paramater>

The Following Settings are available in OperLog:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS

NICK Setting

This setting is to change the nickname that the OperLog module uses for the Bot.

This setting defaults to "OperLog"

ALTNICK Setting

This setting is to change the nickname that the OperLog module uses for the Bot if the Primary Nickname is not available

This setting defaults to "OperLog1"

USER Setting

The "User" that the OperLog bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that OperLog will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that OperLog will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if OperLog should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

Chapter 11. QuoteServ

QuoteServ is designed to ....

Command Reference

The following Commands may be used with QuoteServ.

HELP

Syntax:

/msg QuoteServ HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg QuoteServ HELP 
/msg QuoteServ HELP INFO

VERSION

Syntax:

/msg QuoteServ version

Description:

Displays the current version of QuoteServ

Example:

/msg QuoteServ VERSION

ABOUT

Syntax:

/msg QuoteServ ABOUT

Description:

Shows a descriptive text about QuoteServ

Example:

/msg QuoteServ ABOUT

CREDITS

Syntax:

/msg QuoteServ CREDITS

Description:

Shows details about the Authors and Contributors of QuoteServ

Example:

/msg QuoteServ CREDITS

LEVELS

Syntax:

/msg QuoteServ LEVELS LIST
/msg QuoteServ LEVELS <command> <newlevel>

Description:

Permissions in QuoteServ are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg QuoteServ LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg QuoteServ LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with QuoteServ. They help you customize QuoteServ and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg QuoteServ SET LIST

/msg QuoteServ SET <option> <paramater>

The Following Settings are available in QuoteServ:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS

NICK Setting

This setting is to change the nickname that the QuoteServ module uses for the Bot.

This setting defaults to "QuoteServ"

ALTNICK Setting

This setting is to change the nickname that the QuoteServ module uses for the Bot if the Primary Nickname is not available

This setting defaults to "QuoteServ1"

USER Setting

The "User" that the QuoteServ bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that QuoteServ will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that QuoteServ will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if QuoteServ should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

Chapter 12. TextServ

TextServ is designed to ....

Command Reference

The following Commands may be used with TextServ.

HELP

Syntax:

/msg TextServ HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg TextServ HELP 
/msg TextServ HELP INFO

VERSION

Syntax:

/msg TextServ version

Description:

Displays the current version of TextServ

Example:

/msg TextServ VERSION

ABOUT

Syntax:

/msg TextServ ABOUT

Description:

Shows a descriptive text about TextServ

Example:

/msg TextServ ABOUT

CREDITS

Syntax:

/msg TextServ CREDITS

Description:

Shows details about the Authors and Contributors of TextServ

Example:

/msg TextServ CREDITS

LEVELS

Syntax:

/msg TextServ LEVELS LIST
/msg TextServ LEVELS <command> <newlevel>

Description:

Permissions in TextServ are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg TextServ LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg TextServ LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with TextServ. They help you customize TextServ and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg TextServ SET LIST

/msg TextServ SET <option> <paramater>

The Following Settings are available in TextServ:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS

NICK Setting

This setting is to change the nickname that the TextServ module uses for the Bot.

This setting defaults to "TextServ"

ALTNICK Setting

This setting is to change the nickname that the TextServ module uses for the Bot if the Primary Nickname is not available

This setting defaults to "TextServ1"

USER Setting

The "User" that the TextServ bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that TextServ will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that TextServ will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if TextServ should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

Chapter 13. ExtAuth

ExtAuth is designed to ....

Command Reference

The following Commands may be used with ExtAuth.

HELP

Syntax:

/msg ExtAuth HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg ExtAuth HELP 
/msg ExtAuth HELP INFO

VERSION

Syntax:

/msg ExtAuth version

Description:

Displays the current version of ExtAuth

Example:

/msg ExtAuth VERSION

ABOUT

Syntax:

/msg ExtAuth ABOUT

Description:

Shows a descriptive text about ExtAuth

Example:

/msg ExtAuth ABOUT

CREDITS

Syntax:

/msg ExtAuth CREDITS

Description:

Shows details about the Authors and Contributors of ExtAuth

Example:

/msg ExtAuth CREDITS

LEVELS

Syntax:

/msg ExtAuth LEVELS LIST
/msg ExtAuth LEVELS <command> <newlevel>

Description:

Permissions in ExtAuth are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg ExtAuth LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the ExtAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg ExtAuth LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with ExtAuth. They help you customize ExtAuth and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg ExtAuth SET LIST

/msg ExtAuth SET <option> <paramater>

The Following Settings are available in ExtAuth:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS

NICK Setting

This setting is to change the nickname that the ExtAuth module uses for the Bot.

This setting defaults to "ExtAuth"

ALTNICK Setting

This setting is to change the nickname that the ExtAuth module uses for the Bot if the Primary Nickname is not available

This setting defaults to "ExtAuth1"

USER Setting

The "User" that the ExtAuth bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that ExtAuth will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that ExtAuth will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if ExtAuth should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

Chapter 14. IRCDAuth

IRCDAuth is designed to ....

Command Reference

The following Commands may be used with IRCDAuth.

HELP

Syntax:

/msg IRCDAuth HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg IRCDAuth HELP 
/msg IRCDAuth HELP INFO

VERSION

Syntax:

/msg IRCDAuth version

Description:

Displays the current version of IRCDAuth

Example:

/msg IRCDAuth VERSION

ABOUT

Syntax:

/msg IRCDAuth ABOUT

Description:

Shows a descriptive text about IRCDAuth

Example:

/msg IRCDAuth ABOUT

CREDITS

Syntax:

/msg IRCDAuth CREDITS

Description:

Shows details about the Authors and Contributors of IRCDAuth

Example:

/msg IRCDAuth CREDITS

LEVELS

Syntax:

/msg IRCDAuth LEVELS LIST
/msg IRCDAuth LEVELS <command> <newlevel>

Description:

Permissions in IRCDAuth are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg IRCDAuth LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the IRCDAuth and IrcdAuth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg IRCDAuth LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with IRCDAuth. They help you customize IRCDAuth and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg IRCDAuth SET LIST

/msg IRCDAuth SET <option> <paramater>

The Following Settings are available in IRCDAuth:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS

NICK Setting

This setting is to change the nickname that the IRCDAuth module uses for the Bot.

This setting defaults to "IRCDAuth"

ALTNICK Setting

This setting is to change the nickname that the IRCDAuth module uses for the Bot if the Primary Nickname is not available

This setting defaults to "IRCDAuth1"

USER Setting

The "User" that the IRCDAuth bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that IRCDAuth will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that IRCDAuth will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if IRCDAuth should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

Chapter 15. Writting Modules

...

Chapter 16. Wirring Perl Modules

...

Chapter 17. Writting C Modules: template

template is designed to ....

Command Reference

The following Commands may be used with template.

HELP

Syntax:

/msg template HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg template HELP 
/msg template HELP INFO

VERSION

Syntax:

/msg template version

Description:

Displays the current version of template

Example:

/msg template VERSION

ABOUT

Syntax:

/msg template ABOUT

Description:

Shows a descriptive text about template

Example:

/msg template ABOUT

CREDITS

Syntax:

/msg template CREDITS

Description:

Shows details about the Authors and Contributors of template

Example:

/msg template CREDITS

LEVELS

Syntax:

/msg template LEVELS LIST
/msg template LEVELS <command> <newlevel>

Description:

Permissions in template are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg template LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the template and template Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg template LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with template. They help you customize template and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg template SET LIST

/msg template SET <option> <paramater>

The Following Settings are available in template:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS

NICK Setting

This setting is to change the nickname that the template module uses for the Bot.

This setting defaults to "template"

ALTNICK Setting

This setting is to change the nickname that the template module uses for the Bot if the Primary Nickname is not available

This setting defaults to "template1"

USER Setting

The "User" that the template bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that template will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that template will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if template should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.

Chapter 18. Writting Authentication Modules: templateauth

templateauth is designed to ....

Command Reference

The following Commands may be used with templateauth.

HELP

Syntax:

/msg templateauth HELP [command]

Description:

HELP displays available commands

HELP COMMAND will display help for that command and the syntax you should use.

Example:

/msg templateauth HELP 
/msg templateauth HELP INFO

VERSION

Syntax:

/msg templateauth version

Description:

Displays the current version of templateauth

Example:

/msg templateauth VERSION

ABOUT

Syntax:

/msg templateauth ABOUT

Description:

Shows a descriptive text about templateauth

Example:

/msg templateauth ABOUT

CREDITS

Syntax:

/msg templateauth CREDITS

Description:

Shows details about the Authors and Contributors of templateauth

Example:

/msg templateauth CREDITS

LEVELS

Syntax:

/msg templateauth LEVELS LIST
/msg templateauth LEVELS <command> <newlevel>

Description:

Permissions in templateauth are controlled via UserLevels. A User can have levels ranging from 0 to 200 and their access to commands can be controled via the Levels Command.

/msg templateauth LEVELS LIST shows the current levels each command is assigned. If you wish to alter a command with a new level use the LEVELS <command> <newlevel> syntax. See below for a example

Note

The Actual Levels that are assigned to users depends upon the Authentication Libary loaded into NeoStats. Currently, 2 Authentication Libaries are shipped with NeoStats. Consult the templateauth and templateauth Module configuration Sections for more info on how these modules calculate a users level.

Example:

/msg templateauth LEVELS HELP 200

This sets the help command to only be available to users with Level 200 or above (not very usefull though!)

Settings Reference

The Following Settings are configurable online with templateauth. They help you customize templateauth and its configuration to suit your network. The following section define the settings. To view or modify the settings the following commands are available:

Example:

/msg templateauth SET LIST

/msg templateauth SET <option> <paramater>

The Following Settings are available in templateauth:

NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS

NICK Setting

This setting is to change the nickname that the templateauth module uses for the Bot.

This setting defaults to "templateauth"

ALTNICK Setting

This setting is to change the nickname that the templateauth module uses for the Bot if the Primary Nickname is not available

This setting defaults to "templateauth1"

USER Setting

The "User" that the templateauth bot will signon to the network as (Ident). If not specified, uses the same as the NeoStats Bot.

HOST Setting

This setting determines the hostname that templateauth will use when signon to the network. If not specified, uses the same as the NeoStats Bot.

REALNAME Setting

This setting determines the Realname that templateauth will use with it signs on to the network. If not specified, uses the same as the NeoStats Bot.

EXCLUSIONS Setting

This setting if templateauth should use the Global Exclusion List maintained by the Main NeoStats Bot.

This setting defaults to enabled.