1140 lines
No EOL
40 KiB
XML
1140 lines
No EOL
40 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
<book>
|
|
<title>User Manual for NeoStats</title>
|
|
|
|
<chapter>
|
|
<title>Introduction</title>
|
|
|
|
<sect1>
|
|
<title>Purpose</title>
|
|
|
|
<para>This document explains how to use NeoStats and the commands
|
|
available for the various components. If you are looking for help
|
|
configuring or installing NeoStats or for support information please
|
|
refer to the README file.</para>
|
|
|
|
<para>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>"</para>
|
|
|
|
<para>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:</para>
|
|
|
|
<para><screen>/msg BotName HELP</screen> To access online help for a
|
|
given command use:</para>
|
|
|
|
<para><screen>/msg BotName HELP COMMAND</screen></para>
|
|
</sect1>
|
|
|
|
<sect1>
|
|
<title>General Usage</title>
|
|
|
|
<para>To send a command to a NeoStats module or bot you will always use
|
|
the following from an IRC Client: <screen>/msg botname command [options]</screen>
|
|
e.g. <screen>/msg NeoStats MAP
|
|
</screen>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. <screen>/msg StatBot MAP</screen>Commands
|
|
are listed here in upper case to make reading this document easier. IRC
|
|
is not case sensitive. This means that:</para>
|
|
|
|
<para><screen>/msg StatServ MAP
|
|
/msg StatServ map
|
|
/msg statserv Map
|
|
</screen>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:</para>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> The syntax used for a
|
|
command</para>
|
|
|
|
<para><emphasis role="bold">Description:</emphasis> Description of the
|
|
command and it's options</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> Example of how to use
|
|
the command</para>
|
|
|
|
<para>Optional parameters are presented between [] e.g. [reason]</para>
|
|
|
|
<para>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</para>
|
|
|
|
<para>When using the command, do not use the [],<> or | from the
|
|
syntax.</para>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>NeoStats</title>
|
|
|
|
<para>The following Section describe NeoStats, or the Core to these
|
|
services</para>
|
|
|
|
<sect1>
|
|
<title>About NeoStats</title>
|
|
|
|
<para>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. </para>
|
|
</sect1>
|
|
|
|
<sect1>
|
|
<title>Command Reference</title>
|
|
|
|
<para>The Following are detailed Descriptions of the available commands:</para>
|
|
|
|
<sect2>
|
|
<title>HELP</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> <screen>/msg NeoStats HELP [command]</screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>HELP displays available commands</para>
|
|
|
|
<para>HELP COMMAND will display help for that command and the syntax
|
|
you should use.</para>
|
|
|
|
<para>Available to users if ONLY_OPERS not set in the configuration
|
|
file</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis><screen>/msg NeoStats HELP
|
|
/msg NeoStats HELP INFO</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>INFO</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats INFO</screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>Shows the current NeoStats uptime and other info.</para>
|
|
|
|
<para>Available to users if ONLY_OPERS not set in the configurationf
|
|
file</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis><screen>/msg NeoStats INFO</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>VERSION</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> <screen>/msg NeoStats VERSION</screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>Shows the current NeoStats version.</para>
|
|
|
|
<para>Available to users if ONLY_OPERS not set in the configuration
|
|
file</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats VERSION</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>LEVEL</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis><screen>/msg NeoStats LEVEL</screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>Allows you to see your permissions level with regards NeoStats.
|
|
0 is lowest, 200 is highest, you could be anywhere in between!
|
|
Available to users if ONLY_OPERS not set in the configuration file</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis><screen>/msg NeoStats LEVEL</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>SHUTDOWN</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> <screen>/msg NeoStats SHUTDOWN [reason]
|
|
</screen><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>Force NeoStats to exit immediately. This command should be used
|
|
wisely. reason is optional.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats SHUTDOWN upgrade</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>RELOAD</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats RELOAD [reason]</screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>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.</para>
|
|
|
|
<para>reason is optional.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats RELOAD Lagged</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>LOAD</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats LOAD <module></screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>Allows you to load a module while NeoStats is running. Some
|
|
modules can not be loaded at runtime, and will return an error.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats LOAD statserv</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>UNLOAD</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats UNLOAD <module></screen><emphasis
|
|
role="bold">Description:</emphasis></para>
|
|
|
|
<para>Allows you to unload a module while NeoStats is running. Some
|
|
modules can not be unloaded at runtime, and will return an error</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats UNLOAD statserv</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>MODLIST</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats MODLIST</screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>Display module names and descriptions of loaded modules</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats MODLIST</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>LOGS</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats LOGS
|
|
</screen><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>Sends today's log file via PRIVMSG/NOTICE.</para>
|
|
|
|
<warning>
|
|
<para>Warning. The sending is not throttled. If you have large log
|
|
files, you may be flooded of IRC</para>
|
|
</warning>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats LOGS</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>RAW</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats RAW COMMAND</screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>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.</para>
|
|
|
|
<warning>
|
|
<para>Problems with RAW are NOT SUPPORTED.</para>
|
|
</warning>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats RAW COMMAND</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>JUPE</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats JUPE Server
|
|
</screen><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>Allows you to jupe a server on the network</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis><screen>/msg NeoStats JUPE jupe.com</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>DEBUG</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis><screen>/msg NeoStats DEBUG</screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>This toggles the debug command, On a large network, this command
|
|
should be used considered dangerous as a large amount of information
|
|
may be sent to you and may flood you off the network.</para>
|
|
|
|
<para><emphasis role="bold"> Example:</emphasis><screen>/msg NeoStats DEBUG</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>USERDUMP</title>
|
|
|
|
<para><emphasis role="bold"> Syntax:</emphasis><screen>/msg NeoStats USERDUMP [nick]</screen><emphasis
|
|
role="bold"> Description:</emphasis></para>
|
|
|
|
<para>When in debug mode, Neostats will echo its user table to the
|
|
services channel. Only useful for debugging Neostats</para>
|
|
|
|
<para>If nick is passed, only the information of that nick is
|
|
returned, otherwise the entire user list is dumped.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats USERDUMP</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>SERVERDUMP</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis><screen>/msg NeoStats SERVERDUMP</screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>When in debug mode, Neostats will echo its server table to the
|
|
services channel. Only useful for debugging Neostats</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis><screen>/msg NeoStats SERVERDUMP</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>CHANDUMP</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats CHANDUMP [channel]
|
|
</screen><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>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.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats CHANDUMP</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>MODBOTLIST</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats MODBOTLIST
|
|
</screen><emphasis role="bold">Description: </emphasis> NeoStats will send you
|
|
by notice a list of the current bots being used on the network for
|
|
each module.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats MODBOTLIST</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>MODSOCKLIST</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis><screen>/msg NeoStats MODSOCKLIST</screen></para>
|
|
|
|
<para><emphasis role="bold">Description</emphasis></para>
|
|
|
|
<para>NeoStats will send you by notice a list of the current sockets
|
|
being used on the network for each module.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats MODSOCKLIST</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>MODTIMERLIST</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats MODTIMERLIST</screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis> NeoStats will
|
|
send you by notice a list of the current timer functions being used on
|
|
the network by each module.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats MODTIMERLIST</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>MODBOTCHANLIST</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis> <screen>/msg NeoStats MODBOTCHANLIST</screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis> NeoStats will
|
|
send you by notice a list of the current bots and the channels they
|
|
are using for each module.</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg NeoStats MODBOTCHANLIST</screen></para>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>StatServ</title>
|
|
|
|
<para>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.</para>
|
|
|
|
<sect1>
|
|
<title>Command Reference</title>
|
|
|
|
<para>The following Commands may be used with StatServ. Some commands
|
|
require privledged access (O lines or Service Roots)</para>
|
|
|
|
<sect2>
|
|
<title>HELP</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis></para>
|
|
|
|
<para><screen>/msg StatServ HELP [command]</screen></para>
|
|
|
|
<para><emphasis role="bold">Description:</emphasis> </para>
|
|
|
|
<para>HELP on it's own display available commands. </para>
|
|
|
|
<para>HELP COMMAND will display help for that command. </para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis></para>
|
|
|
|
<para><screen>/msg StatServ HELP /msg StatServ HELP STATS</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>CLIENTVERSIONS</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis></para>
|
|
|
|
<para><screen>/msg StatServ CLIENTVERSIONS <limit> </screen></para>
|
|
|
|
<para><emphasis role="bold">Description:</emphasis> </para>
|
|
|
|
<para>Provides Statistics on the Client Versions found The list will
|
|
only be active if you have SecureServ installed and Active
|
|
<limit> Specifies how many results to show. Results are sorted
|
|
by Most Popular to Least Popular </para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis></para>
|
|
|
|
<para><screen>/msg StatServ CLIENTVERSIONS</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>SET</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis></para>
|
|
|
|
<para><screen>/msg StatServ Set <option> [<value>]</screen><emphasis
|
|
role="bold">Description:</emphasis> </para>
|
|
|
|
<para>Available Options are: </para>
|
|
|
|
<para><emphasis>HTMLPATH <path></emphasis> </para>
|
|
|
|
<para>Set the Pathname (including filename) to write HTML statistics
|
|
to if HTML Statistics are enabled HTML Toggle HTML Statistics
|
|
Generation on/off </para>
|
|
|
|
<para><emphasis>MSGTHROTTLE [<seconds>/off]</emphasis> </para>
|
|
|
|
<para>if <seconds> is greater than 0, then set 5 Wallops per
|
|
<seconds> throttle if <seconds> is equal to 0, then
|
|
disable Wallop Throttling if off then all Wallops are disabled </para>
|
|
|
|
<para><emphasis>LAGWALLOP <seconds></emphasis> </para>
|
|
|
|
<para>if <seconds> is greater than 0, then when servers are
|
|
lagged by this many seconds, issue a warning if <seconds> is
|
|
equal to 0, then disable Lag Monitoring </para>
|
|
|
|
<para>If you specify SET without any options, the current settings are
|
|
displayed </para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> </para>
|
|
|
|
<para><screen>/msg statserv set msgthrottle off</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>CHAN</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> </para>
|
|
|
|
<para><screen>/msg StatServ CHAN <POP/KICKS/TOPICS/<Channame>></screen><emphasis
|
|
role="bold">Description:</emphasis> </para>
|
|
|
|
<para>Provides Statistics on Channels on the network </para>
|
|
|
|
<para><emphasis>CHAN </emphasis></para>
|
|
|
|
<para>By itself provides a list of the top10 Channels based on the
|
|
current number of members </para>
|
|
|
|
<para><emphasis>CHAN POP </emphasis></para>
|
|
|
|
<para>gives you information on the most popular channels on the
|
|
network based on the number of joins </para>
|
|
|
|
<para><emphasis>CHAN KICKS</emphasis> </para>
|
|
|
|
<para>Gives you the top 10 kicking channels </para>
|
|
|
|
<para><emphasis>CHAN TOPICS</emphasis> </para>
|
|
|
|
<para>Gives you the top10 Topic Changing Channels </para>
|
|
|
|
<para><emphasis>CHAN <name></emphasis> </para>
|
|
|
|
<para>Gives you specific information on a channel </para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg statserv chan #neostats</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>SERVER</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> </para>
|
|
|
|
<para><screen>/msg StatServ SERVER [server name]</screen><emphasis
|
|
role="bold">Description:</emphasis> </para>
|
|
|
|
<para>Provides you with statistics on a specific server. </para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> </para>
|
|
|
|
<para><screen>/msg statserv server rollergirl.sg.as.irc-chat.net</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>MAP</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> <screen>/msg StatServ MAP</screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>Provides a server listing with minimal statistics. </para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg StatServ MAP</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>NETSTATS</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> <screen>/msg StatServ NETSTATS</screen><emphasis
|
|
role="bold"> Description</emphasis></para>
|
|
|
|
<para> Provides information about the performance of the network.
|
|
</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg StatServ NETSTATS</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>DAILY</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> <screen>/msg StatServ DAILY </screen><emphasis
|
|
role="bold">Description:</emphasis> </para>
|
|
|
|
<para>Provides information about records that have been set today.
|
|
</para>
|
|
|
|
<para><emphasis role="bold">Example:</emphasis> <screen>/msg StatServ DAILY</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>TLD</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis><screen>/msg StatServ TLD top_level_domain </screen></para>
|
|
|
|
<para><emphasis role="bold">Description:</emphasis></para>
|
|
|
|
<para>Provides the country-name for a specific TLD. An example of a
|
|
TLD is .NET </para>
|
|
|
|
<para><emphasis role="bold">Example: </emphasis></para>
|
|
|
|
<para><screen>/msg StatServ TLD NET</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>TLDMAP</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis><screen>/msg StatServ TLDMAP </screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>Shows the network map in relation to top level domains. </para>
|
|
|
|
<para><emphasis role="bold">Example: </emphasis></para>
|
|
|
|
<para><screen>/msg StatServ TLDMAP</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>OPERLIST</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis><screen>/msg StatServ OPERLIST (options|server_name) </screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>Shows a listing of IRCops. </para>
|
|
|
|
<para>Flags: </para>
|
|
|
|
<para><emphasis>NOAWAY</emphasis> </para>
|
|
|
|
<para>Don't show opers that are set away. </para>
|
|
|
|
<para><emphasis>SERVER</emphasis> </para>
|
|
|
|
<para>Only show opers on that server. </para>
|
|
|
|
<para><emphasis role="bold">Example: </emphasis></para>
|
|
|
|
<para><screen>/msg statserv operlist
|
|
/msg statserv operlist noaway
|
|
/msg statserv operlist <server></screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>BOTLIST</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis><screen>/msg StatServ BOTLIST </screen><emphasis
|
|
role="bold">Description: </emphasis></para>
|
|
|
|
<para>Shows all current bots on the network. (umode +B users if your
|
|
IRCD supports Umode +B) </para>
|
|
|
|
<para><emphasis role="bold">Example: </emphasis><screen>/msg StatServ BOTLIST</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>VERSION</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis><screen>/msg StatServ VERSION</screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>Shows the current StatServ Version. </para>
|
|
|
|
<para><emphasis role="bold">Example: </emphasis><screen>/msg StatServ VERSION</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>STATS</title>
|
|
|
|
<para><emphasis role="bold">Syntax: </emphasis><screen>/msg StatServ STATS [DEL|LIST|COPY] </screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para><emphasis>LIST </emphasis></para>
|
|
|
|
<para>List all database entries. </para>
|
|
|
|
<para><emphasis>DEL </emphasis><emphasis>name</emphasis> </para>
|
|
|
|
<para>Remove an entry. </para>
|
|
|
|
<para><emphasis>COPY name newname </emphasis></para>
|
|
|
|
<para>Copy an entry. </para>
|
|
|
|
<para><emphasis role="bold">Example: </emphasis><screen>/msg StatServ STATS LIST</screen></para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>FORCEHTML</title>
|
|
|
|
<para><emphasis role="bold">Syntax:</emphasis> <screen>/msg StatServ FORCEHTML </screen></para>
|
|
|
|
<para><emphasis role="bold">Description: </emphasis></para>
|
|
|
|
<para>Forces an update of the HTML data file with the most current
|
|
network statistics. </para>
|
|
|
|
<para><emphasis role="bold">Example: </emphasis><screen>/msg StatServ FORCEHTML</screen></para>
|
|
</sect2>
|
|
</sect1>
|
|
|
|
<sect1>
|
|
<title>HTML Template Syntax</title>
|
|
|
|
<para>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 ! </para>
|
|
|
|
<para>The available template variables are: </para>
|
|
|
|
<para><emphasis role="bold">!MAP!</emphasis> -Outputs a network </para>
|
|
|
|
<para>Map similar to /msg statserv map in a table format </para>
|
|
|
|
<para><emphasis role="bold">!SRVLIST! </emphasis>-Outputs a complete
|
|
list of servers that StatServ has ever seen, which are linked to
|
|
detailed server information provided by the template variable
|
|
!SRVLISTDET! </para>
|
|
|
|
<para><emphasis role="bold">!SRVLISTDET! </emphasis>-Outputs detailed
|
|
server information </para>
|
|
|
|
<para>see also !SRVLIST! </para>
|
|
|
|
<para><emphasis role="bold">!NETSTATS! </emphasis>-Outputs Network
|
|
Statistics </para>
|
|
|
|
<para>similar to /msg statserv netstats </para>
|
|
|
|
<para><emphasis role="bold">!DAILYSTATS! </emphasis>-Outputs the Daily
|
|
Statistics </para>
|
|
|
|
<para>similar to /msg statserv daily </para>
|
|
|
|
<para><emphasis role="bold">!DAILYTOPCHAN! </emphasis>-Outputs the top10
|
|
channels based on number of members </para>
|
|
|
|
<para><emphasis role="bold">!TOP10CHAN! </emphasis>-Outputs the top10
|
|
channels ever based on number of joins </para>
|
|
|
|
<para><emphasis role="bold">!TOP10KICKS! </emphasis>-Outputs the top10
|
|
kicking channels </para>
|
|
|
|
<para><emphasis role="bold">!TOP10TOPICS! </emphasis>-Outputs the top10
|
|
topic changing channels </para>
|
|
|
|
<para><emphasis role="bold">!TLDMAP! </emphasis>-Outputs the TLD map
|
|
</para>
|
|
|
|
<para>similar to /msg statserv tldmap </para>
|
|
|
|
<para><emphasis role="bold">!VERSION! </emphasis>-Outputs the version of
|
|
NeoStats </para>
|
|
|
|
<para><emphasis role="bold">!TITLE! </emphasis>-Outputs title in the
|
|
form: "Network Statistics for YourNetName" </para>
|
|
|
|
<para><emphasis role="bold">!CLIENTSTATS! </emphasis>-Outputs Top 10
|
|
clients used on the network. (Requires SecureServ module with version
|
|
checks enabled). </para>
|
|
|
|
<para>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!) </para>
|
|
|
|
<para>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.</para>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>ConnectServ</title>
|
|
|
|
<para>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.</para>
|
|
|
|
<sect1>
|
|
<title>Command Reference</title>
|
|
|
|
<para>The following commands are aviable for ConnectServ. All these
|
|
commands require Privledged access</para>
|
|
|
|
<sect2>
|
|
<title>HELP</title>
|
|
|
|
<para>Syntax: /msg ConnectServ HELP [command] Description: HELP on
|
|
it's own display available commands. HELP COMMAND will display
|
|
help for that command. Example: /msg ConnectServ HELP /msg ConnectServ
|
|
HELP STATUS</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>ABOUT</title>
|
|
|
|
<para>Syntax: /msg ConnectServ ABOUT Description: The ABOUT command
|
|
will return a description of ConnectServ. Example: /msg ConnectServ
|
|
ABOUT</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>SET</title>
|
|
|
|
<para>Syntax: /msg ConnectServ SET <option> [<value>]
|
|
Description: Available Options are: LIST This will tell you the
|
|
current status of the settings. e.g.: MODEWATCH is enabled. SIGNWATCH
|
|
<ON|OFF> echo signon/signoff events. KILLWATCH
|
|
<ON|OFF> echo kill events. MODEWATCH <ON|OFF> echo
|
|
operator mode changes. NICKWATCH <ON|OFF> echo nickname
|
|
changes. Example: /msg ConnectServ SET NICKWATCH ON</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>VERSION</title>
|
|
|
|
<para>Syntax: /msg ConnectServ VERSION Description: Shows the current
|
|
ConnectServ version. Example: /msg ConnectServ VERSION</para>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>HostServ</title>
|
|
|
|
<para>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.</para>
|
|
|
|
<sect1>
|
|
<title>Command Reference</title>
|
|
|
|
<para>The Following commands are available for Hostserv. By Default,
|
|
users with level 185 or higher access can modify the levels required to
|
|
use some of the privledged commands.</para>
|
|
|
|
<sect2>
|
|
<title>HELP</title>
|
|
|
|
<para>Syntax: /msg HostServ HELP [command] Description: HELP on
|
|
it's own display available commands. HELP COMMAND will display
|
|
help for that command. Example: /msg HostServ HELP /msg HostServ HELP
|
|
ADD</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>ABOUT</title>
|
|
|
|
<para>Syntax: /msg HostServ ABOUT Description: The ABOUT command will
|
|
return a description of HostServ. Example: /msg HostServ ABOUT</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>ADD</title>
|
|
|
|
<para>Syntax: /msg HostServ ADD <NICK> <HOST NAME>
|
|
<VIRTUAL HOST NAME> <PASSWORD> Description: Register a
|
|
host name to be set. e.g.: my-host.com DO NOT INCLUDE AN @. The
|
|
<HOST NAME> must be where the user is connecting from WITHOUT
|
|
THE @. HostServ supports wildcards such as *.myhost.com in the
|
|
<HOST NAME> setting The <PASSWORD> field is new. If a
|
|
user connects with a different host They can now /msg HostServ LOGIN
|
|
nick password Example: /msg HostServ ADD neo aol.com coolhost.com
|
|
mypassword</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>DEL</title>
|
|
|
|
<para>Syntax: /msg HostServ DEL <ACCESS LIST #> Description:
|
|
The information needed for this is in the LIST command. To delete
|
|
Number 3 use DEL 3 ... its that easy! Example: /msg HostServ DEL 1</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>VIEW</title>
|
|
|
|
<para>Syntax: /msg HostServ VIEW <ACCESS LIST #> Description:
|
|
View Detailed information about the user on the access list # you
|
|
selected Example: /msg HostServ VIEW 1</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>LIST</title>
|
|
|
|
<para>Syntax: /msg HostServ LIST <start> Description: Lists
|
|
the people and vhosts in the Database. Only lists a maxium of 20
|
|
entries For more descriptive info on a SINGLE vhost see HELP VIEW if
|
|
<start> is specified, start the listing at number
|
|
<start></para>
|
|
|
|
<para>Example: /msg HostServ LIST</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>LOGIN</title>
|
|
|
|
<para>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</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>CHPASS</title>
|
|
|
|
<para>Syntax: /msg HostServ CHPASS <NICK> <OLDPASS>
|
|
<NEWPASS> Description: Use this command to change the password
|
|
assigned to your Vhost Account. You must supply your current password
|
|
and a valid account for it to be successful Example: /msg HostServ
|
|
CHPASS Angel oldpass newpass</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>BANS</title>
|
|
|
|
<para>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</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>LEVELS</title>
|
|
|
|
<para>Syntax: /msg HostServ LEVELS <[add/view/list/del]
|
|
<level>> Description: This lists the levels required to
|
|
perform certain functions with HostServ. The Following Options are
|
|
only available to Network Administration: LEVELS [add/view/list/del]
|
|
<level> Change the User Levels required to perform
|
|
administration functions. Level must be between 1 and 200 Example:</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>SET</title>
|
|
|
|
<para>TODO</para>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>LoveServ</title>
|
|
|
|
<para>LoveServ is a fun module to send presents and messages to loved ones
|
|
on IRC.</para>
|
|
|
|
<sect1>
|
|
<title>Command Reference</title>
|
|
|
|
<para>The following commands may be used by users to send messages of
|
|
love to other IRC users</para>
|
|
|
|
<sect2>
|
|
<title>HELP</title>
|
|
|
|
<para>Syntax: /msg LoveServ HELP [command] Description: HELP on
|
|
it's own display available commands. HELP COMMAND will display
|
|
help for that command. Example: /msg LoveServ HELP /msg LoveServ HELP
|
|
ROSE</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>ROSE</title>
|
|
|
|
<para>Syntax: /msg LoveServ ROSE <nick> Description: Send a
|
|
rose to a loved one on IRC. Example: /msg LoveServ ROSE Angel</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>KISS</title>
|
|
|
|
<para>Syntax: /msg LoveServ KISS <nick> Description: Send a
|
|
kiss to that special someone on IRC. Example: /msg LoveServ KISS Angel</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>TONSIL</title>
|
|
|
|
<para>Syntax: /msg LoveServ TONSIL <nick> Description: Send a
|
|
deep tonsil penetrating kiss to someone on IRC. Example: /msg LoveServ
|
|
TONSIL Angel</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>HUG</title>
|
|
|
|
<para>Syntax: /msg LoveServ HUG <nick> Description: Send a hug
|
|
to someone on IRC. Example: /msg LoveServ HUG Angel</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>ADMIRER</title>
|
|
|
|
<para>Syntax: /msg LoveServ ADMIRER <nick> Description: Tell
|
|
someone on IRC they have a SECRET Admirer! Example: /msg LoveServ
|
|
ADMIRER Angel</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>CHOCOLATE</title>
|
|
|
|
<para>Syntax: /msg LoveServ CHOCOLATE <nick> Description: Send
|
|
a big yummy box of candy to someone on IRC. Example: /msg LoveServ
|
|
CHOCOLATE Angel</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>CANDY</title>
|
|
|
|
<para>Syntax: /msg LoveServ CANDY NICK Description: Send someone a box
|
|
of yummy heart shaped candies Example: /msg LoveServ CANDY Angel</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>LOVENOTE</title>
|
|
|
|
<para>Syntax: /msg LoveServ LOVENOTE NICK <message>
|
|
Description: Send that special someone a love note. Example: /msg
|
|
LoveServ LOVENOTE Angel I love you dearly.</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>APOLOGY</title>
|
|
|
|
<para>Syntax: /msg LoveServ APOLOGY NICK <message>
|
|
Description: Send an Apology to someone Example: /msg LoveServ APOLOGY
|
|
Angel deleting all those songs</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>THANKYOU</title>
|
|
|
|
<para>Syntax: /msg LoveServ THANKYOU NICK <message>
|
|
Description: Send a THANKYOU message to someone Example: /msg LoveServ
|
|
THANKYOU Angel uploading those songs</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>VERSION</title>
|
|
|
|
<para>Syntax: /msg LoveServ VERSION Description: Show LoveServ's
|
|
current version Example: /msg LoveServ VERSION</para>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>MoraleServ</title>
|
|
|
|
<para>MoraleServ is a fun module to send cheery messages to friends on
|
|
IRC.</para>
|
|
|
|
<sect1>
|
|
<title>Command Reference</title>
|
|
|
|
<para>The Following commands may be used by any IRC user to cheer up
|
|
another user</para>
|
|
|
|
<sect2>
|
|
<title>HELP</title>
|
|
|
|
<para>Syntax: /msg MoraleServ HELP [command] Description: HELP on
|
|
it's own display available commands. HELP COMMAND will display
|
|
help for that command. Example: /msg MoraleServ HELP /msg MoraleServ
|
|
HELP HAIL</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>HAIL</title>
|
|
|
|
<para>Syntax: /msg MoraleServ HAIL <hail nick> <send to
|
|
nick> Description: Send a HAIL song greeting to a loved one on
|
|
IRC. Example: /msg MoraleServ HAIL Angel Devil</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>ODE</title>
|
|
|
|
<para>Syntax: /msg MoraleServ ODE <about nick> <send to
|
|
nick> Description: Send an ode about a user to a loved one on IRC.
|
|
Example: /msg MoraleServ ODE Angel Devil</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>POEM</title>
|
|
|
|
<para>Syntax: /msg MoraleServ POEM <about nick> <send to
|
|
nick> Description: Send a poem about a user to a loved one on IRC.
|
|
Example: /msg MoraleServ POEM Angel Devil</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>LAPDANCE</title>
|
|
|
|
<para>Syntax: /msg MoraleServ LAPDANCE <NICK> Description:
|
|
Send a lap dance to a loved one on IRC... sure to cheer any person up
|
|
Example: /msg MoraleServ LAPDANCE YoungGuy</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>REDNECK</title>
|
|
|
|
<para>Syntax: /msg MoraleServ REDNECK <NICK> Description: Send
|
|
a redneck dubbing to a loved one on IRC. Example: /msg MoraleServ
|
|
REDNECK Yankee</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>CHEERUP</title>
|
|
|
|
<para>Syntax: /msg MoraleServ CHEERUP <NICK> Description: Send
|
|
a cheer up message to a loved one on IRC to cheer them up. Example:
|
|
/msg MoraleServ CHEERUP Morbid</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>BEHAPPY</title>
|
|
|
|
<para>Syntax: /msg MoraleServ BEHAPPY <NICK> Description: Send
|
|
a be happy song to a loved one on IRC to cheer them up. This function
|
|
sends a number of messages that may ping the target nick out if they
|
|
do not have a fast connection. DO NOT USE unless you are sure.
|
|
Example: /msg MoraleServ BEHAPPY SadUser</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>WONDERFUL</title>
|
|
|
|
<para>Syntax: /msg MoraleServ WONDERFUL <NICK> Description:
|
|
Send an "I hope you don't mind, that I put down in
|
|
words..." song to a loved one on IRC to cheer them up. This
|
|
function will send the lyrics with the target nick in them to the
|
|
target nick Example: /msg MoraleServ WONDERFUL Angel</para>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>VERSION</title>
|
|
|
|
<para>Syntax: /msg MoraleServ VERSION Description: Prints current
|
|
version information via PRIVMSG/NOTICE Example: /msg MoraleServ
|
|
VERSION</para>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Spam</title>
|
|
|
|
<para>Spam provides a bot to try and catch spammers and mass messagers. It
|
|
will sit on the network and echo to the services channel and by wallops
|
|
when someone sends it a message and what message they sent. Currently the
|
|
spam bot has a fixed name of "sumyungguy". Send it a message, and
|
|
watch what happens.</para>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>ExtAuth</title>
|
|
|
|
<para>ExtAuth may be listed as a loaded module, but its not a true module
|
|
as described above. It allows you to provide an alternative Authentication
|
|
/level scheme that is not based on Umodes. You should consult the README
|
|
file for neostats for more detailed information regarding its
|
|
configuration.</para>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Other Modules</title>
|
|
|
|
<para>So if you are wondering where the other modules are, like
|
|
SecureServ, or StupidServ, these modules are not included in the base
|
|
distribution of NeoStats. You must download and compile these modules
|
|
seperatly from the main neostats distribution.</para>
|
|
|
|
<para>More information about how to use these modules can be found in the
|
|
Modules README file, or on our website.</para>
|
|
</chapter>
|
|
</book> |