This repository has been archived on 2025-02-12. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
NeoStats/doc/old/USERMAN.html

673 lines
161 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Manual for NeoStats</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1" /></head><body><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id823908"></a>Manual for NeoStats</h1></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#id823902">1. Introduction To NeoStats</a></span></dt><dt><span class="chapter"><a href="#id900137">2. QuickStart Guide</a></span></dt><dt><span class="chapter"><a href="#id900146">3. Installing NeoStats</a></span></dt><dt><span class="chapter"><a href="#id900154">4. Using NeoStats &amp; Supplied Modules</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id900160">Purpose</a></span></dt><dt><span class="sect1"><a href="#id900207">General Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id900300">5. NeoStats</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id900310">About NeoStats</a></span></dt><dt><span class="sect1"><a href="#id900327">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id900337">HELP</a></span></dt><dt><span class="sect2"><a href="#id900385">VERSION</a></span></dt><dt><span class="sect2"><a href="#id900424">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id900464">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id900503">LEVELS</a></span></dt><dt><span class="sect2"><a href="#id900572">LEVEL</a></span></dt><dt><span class="sect2"><a href="#id900611">STATUS</a></span></dt><dt><span class="sect2"><a href="#id900651">SHUTDOWN</a></span></dt><dt><span class="sect2"><a href="#id900693">RELOAD</a></span></dt><dt><span class="sect2"><a href="#id900743">LOAD</a></span></dt><dt><span class="sect2"><a href="#id900785">UNLOAD</a></span></dt><dt><span class="sect2"><a href="#id900828">MODLIST</a></span></dt><dt><span class="sect2"><a href="#id900868">RAW</a></span></dt><dt><span class="sect2"><a href="#id900932">JUPE</a></span></dt><dt><span class="sect2"><a href="#id900971">EXCLUDE</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id901035">Debugging Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id901045">USERLIST</a></span></dt><dt><span class="sect2"><a href="#id901091">CHANNELLIST</a></span></dt><dt><span class="sect2"><a href="#id901136">SERVERLIST</a></span></dt><dt><span class="sect2"><a href="#id901175">BANLIST</a></span></dt><dt><span class="sect2"><a href="#id901215">BOTLIST</a></span></dt><dt><span class="sect2"><a href="#id901255">SOCKLIST</a></span></dt><dt><span class="sect2"><a href="#id901297">TIMERLIST</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id901340">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id901380">CMDCHAR Setting </a></span></dt><dt><span class="sect2"><a href="#id901413">MSGTHRESHOLD Setting</a></span></dt><dt><span class="sect2"><a href="#id901446">MSGSAMPLETIME Setting</a></span></dt><dt><span class="sect2"><a href="#id901471">DEBUGCHAN Setting</a></span></dt><dt><span class="sect2"><a href="#id901492">ALLHELP Setting</a></span></dt><dt><span class="sect2"><a href="#id901513">REVCQ Setting</a></span></dt><dt><span class="sect2"><a href="#id901549">CMDREPORT Setting</a></span></dt><dt><span class="sect2"><a href="#id901574">SERVICEUMODE Setting</a></span></dt><dt><span class="sect2"><a href="#id901600">SENDHELP Setting</a></span></dt><dt><span class="sect2"><a href="#id901627">SPLITTIME Setting</a></span></dt><dt><span class="sect2"><a href="#id901665">LOGLEVEL Setting</a></span></dt><dt><span class="sect2"><a href="#id901689">SERVICECMODE Setting</a></span></dt><dt><span class="sect2"><a href="#id901713">JOINSERVICESCHAN Setting</a></span></dt><dt><span class="sect2"><a href="#id901737">PINGTIME Setting</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id901756">Debugging Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id901766">DEBUGTOCHAN Setting</a></span></dt><dt><span class="sect2"><a href="#id901780">DEBUGMODULE Setting</a></span></dt><dt><span class="sect2"><a href="#id901793">DEBUGLEVEL Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id901806">6. StatServ</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id901817">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id901828">HELP</a></span></dt><dt><span class="sect2"><a href="#id901872">VERSION</a></span></dt><dt><span class="sect2"><a href="#id901911">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id901950">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id901990">LEVELS</a></span></dt><dt><span class="sect2"><a href="#id902054">CTCPVERSION</a></span></dt><dt><span class="sect2"><a href="#id902104">CHANNEL</a></span></dt><dt><span class="sect2"><a href="#id902191">SERVER</a></span></dt><dt><span class="sect2"><a href="#id902274">MAP</a></span></dt><dt><span class="sect2"><a href="#id902316">NETSTATS</a></span></dt><dt><span class="sect2"><a href="#id902357">DAILY</a></span></dt><dt><span class="sect2"><a href="#id902397">TLDMAP</a></span></dt><dt><span class="sect2"><a href="#id902440">OPERLIST</a></span></dt><dt><span class="sect2"><a href="#id902504">BOTLIST</a></span></dt><dt><span class="sect2"><a href="#id902543">FORCEHTML</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id902586">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id902623">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id902639">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id902655">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id902667">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id902680">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id902693">EXCLUSIONS Setting</a></span></dt><dt><span class="sect2"><a href="#id902709">RECORDALERT Setting</a></span></dt><dt><span class="sect2"><a href="#id902741">HTMLPATH Setting</a></span></dt><dt><span class="sect2"><a href="#id902767">HTMLTIME Setting</a></span></dt><dt><span class="sect2"><a href="#id902783">HTML Setting</a></span></dt><dt><span class="sect2"><a href="#id902798">CHANNELTIME Setting</a></span></dt><dt><span class="sect2"><a href="#id902816">MSGLIMIT Setting</a></span></dt><dt><span class="sect2"><a href="#id902834">MSGINTERVAL Setting</a></span></dt><dt><span class="sect2"><a href="#id902852">FLATMAP Setting</a></span></dt><dt><span class="sect2"><a href="#id902868">LAGTIME Setting</a></span></dt><dt><span class="sect2"><a href="#id902880">LAG Setting</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id902916">HTML Template Syntax</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id903086">7. ConnectServ</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id903100">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id903110">HELP</a></span></dt><dt><span class="sect2"><a href="#id903154">VERSION</a></span></dt><dt><span class="sect2"><a href="#id903193">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id903233">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id903272">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id903342">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id903378">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id903393">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id903410">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id903422">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id903434">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id903448">EXCLUSIONS Setting</a></span></dt><dt><span class="sect2"><a href="#id903464">LOGGING Setting</a></span></dt><dt><span class="sect2"><a href="#id903480">KILLWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903495">SERVWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903510">NICKWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903525">SIGNWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903541">MODEWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903557">AWAYWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903572">COLOUR Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id903590">8. HostServ</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id903603">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id903613">HELP</a></span></dt><dt><span class="sect2"><a href="#id903657">VERSION</a></span></dt><dt><span class="sect2"><a href="#id903697">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id903736">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id903776">LEVELS</a></span></dt><dt><span class="sect2"><a href="#id903844">ADD</a></span></dt><dt><span class="sect2"><a href="#id903883">DEL</a></span></dt><dt><span class="sect2"><a href="#id903928">LIST</a></span></dt><dt><span class="sect2"><a href="#id903970">VIEW</a></span></dt><dt><span class="sect2"><a href="#id904008">LOGIN</a></span></dt><dt><span class="sect2"><a href="#id904050">BANS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id904115">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id904152">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id904168">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id904184">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id904196">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id904209">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id904222">EXCLUSIONS Setting</a></span></dt><dt><span class="sect2"><a href="#id904238">VERBOSE Setting</a></span></dt><dt><span class="sect2"><a href="#id904254">HIDDENHOST Setting</a></span></dt><dt><span class="sect2"><a href="#id904277">HOSTNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id904293">OPERHOST Setting</a></span></dt><dt><span class="sect2"><a href="#id904314">ADDLEVEL Setting</a></span></dt><dt><span class="sect2"><a href="#id904329">EXPIRE Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id904348">9. LimitServ</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id904357">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id904368">HELP</a></span></dt><dt><span class="sect2"><a href="#id904412">VERSION</a></span></dt><dt><span class="sect2"><a href="#id904451">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id904490">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id904530">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id904596">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id904630">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id904645">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id904662">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id904674">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id904686">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id904700">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id904718">10. OperLog</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id904727">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id904737">HELP</a></span></dt><dt><span class="sect2"><a href="#id904781">VERSION</a></span></dt><dt><span class="sect2"><a href="#id904821">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id904860">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id904900">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id904969">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905003">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905018">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905034">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id905046">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id905059">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id905072">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id905090">11. QuoteServ</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id905100">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905110">HELP</a></span></dt><dt><span class="sect2"><a href="#id905154">VERSION</a></span></dt><dt><span class="sect2"><a href="#id905193">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id905232">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id905272">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id905341">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905376">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905391">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905407">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id905419">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id905432">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id905445">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id905463">12. TextServ</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id905472">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905482">HELP</a></span></dt><dt><span class="sect2"><a href="#id905527">VERSION</a></span></dt><dt><span class="sect2"><a href="#id905566">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id905605">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id905645">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id905714">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905748">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905764">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905780">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id905792">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id905805">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id905818">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id905836">13. ExtAuth</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id905845">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905855">HELP</a></span></dt><dt><span class="sect2"><a href="#id905900">VERSION</a></span></dt><dt><span class="sect2"><a href="#id905939">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id905978">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id906018">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id906087">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906121">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906136">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906152">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id906165">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id906177">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id906190">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id906208">14. IRCDAuth</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id906218">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906228">HELP</a></span></dt><dt><span class="sect2"><a href="#id906272">VERSION</a></span></dt><dt><span class="sect2"><a href="#id906311">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id906350">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id906390">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id906460">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906494">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906509">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906525">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id906537">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id906550">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id906563">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id906581">15. Writting Modules</a></span></dt><dt><span class="chapter"><a href="#id906591">16. Wirring Perl Modules</a></span></dt><dt><span class="chapter"><a href="#id906601">17. Writting C Modules: template</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id906611">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906621">HELP</a></span></dt><dt><span class="sect2"><a href="#id906665">VERSION</a></span></dt><dt><span class="sect2"><a href="#id906705">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id906744">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id906784">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id906853">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906887">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906902">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906918">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id906931">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id906943">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id906956">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id906974">18. Writting Authentication Modules: templateauth</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id906985">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906995">HELP</a></span></dt><dt><span class="sect2"><a href="#id907040">VERSION</a></span></dt><dt><span class="sect2"><a href="#id907079">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id907118">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id907158">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id907228">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id907262">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id907278">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id907294">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id907307">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id907320">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id907333">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id823902"></a>Chapter 1. Introduction To NeoStats</h2></div></div></div><p></p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id900137"></a>Chapter 2. QuickStart Guide</h2></div></div></div><p></p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id900146"></a>Chapter 3. Installing NeoStats</h2></div></div></div><p></p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id900154"></a>Chapter 4. Using NeoStats &amp; Supplied Modules</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id900160">Purpose</a></span></dt><dt><span class="sect1"><a href="#id900207">General Usage</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id900160"></a>Purpose</h2></div></div></div><p>The rest of this document explains how to use NeoStats and the
commands available for the various components. </p><p>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.&lt;modulename&gt;"</p><p>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:</p><pre class="screen">/msg BotName HELP</pre><p> To access online help for a
given command use:</p><pre class="screen">/msg BotName HELP COMMAND</pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id900207"></a>General Usage</h2></div></div></div><p>To send a command to a NeoStats module or bot you will always use
the following from an IRC Client: </p><pre class="screen">/msg botname command [options]</pre><p>
e.g. </p><pre class="screen">/msg NeoStats SET</pre><p>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. </p><pre class="screen">/msg StatBot MAP</pre><p>Commands are listed here
in upper case to make reading this document easier. IRC is not case
sensitive. This means that:</p><pre class="screen">/msg StatServ MAP
/msg StatServ map
/msg statserv Map</pre><p>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:</p><p><span class="bold"><strong>Syntax:</strong></span> The syntax used for a
command</p><p><span class="bold"><strong>Description:</strong></span> Description of the
command and it's options</p><p><span class="bold"><strong>Example:</strong></span> Example of how to use
the command</p><p>Optional parameters are presented between [] e.g. [reason]</p><p>Required parameters are presented between &lt;&gt; e.g.
&lt;reason&gt; The | character indicates that only one of the option
list can be used at any one time. e.g. option1|option2</p><p>When using the command, do not use the [],&lt;&gt; or | from the
syntax.</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id900300"></a>Chapter 5. NeoStats</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id900310">About NeoStats</a></span></dt><dt><span class="sect1"><a href="#id900327">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id900337">HELP</a></span></dt><dt><span class="sect2"><a href="#id900385">VERSION</a></span></dt><dt><span class="sect2"><a href="#id900424">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id900464">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id900503">LEVELS</a></span></dt><dt><span class="sect2"><a href="#id900572">LEVEL</a></span></dt><dt><span class="sect2"><a href="#id900611">STATUS</a></span></dt><dt><span class="sect2"><a href="#id900651">SHUTDOWN</a></span></dt><dt><span class="sect2"><a href="#id900693">RELOAD</a></span></dt><dt><span class="sect2"><a href="#id900743">LOAD</a></span></dt><dt><span class="sect2"><a href="#id900785">UNLOAD</a></span></dt><dt><span class="sect2"><a href="#id900828">MODLIST</a></span></dt><dt><span class="sect2"><a href="#id900868">RAW</a></span></dt><dt><span class="sect2"><a href="#id900932">JUPE</a></span></dt><dt><span class="sect2"><a href="#id900971">EXCLUDE</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id901035">Debugging Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id901045">USERLIST</a></span></dt><dt><span class="sect2"><a href="#id901091">CHANNELLIST</a></span></dt><dt><span class="sect2"><a href="#id901136">SERVERLIST</a></span></dt><dt><span class="sect2"><a href="#id901175">BANLIST</a></span></dt><dt><span class="sect2"><a href="#id901215">BOTLIST</a></span></dt><dt><span class="sect2"><a href="#id901255">SOCKLIST</a></span></dt><dt><span class="sect2"><a href="#id901297">TIMERLIST</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id901340">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id901380">CMDCHAR Setting </a></span></dt><dt><span class="sect2"><a href="#id901413">MSGTHRESHOLD Setting</a></span></dt><dt><span class="sect2"><a href="#id901446">MSGSAMPLETIME Setting</a></span></dt><dt><span class="sect2"><a href="#id901471">DEBUGCHAN Setting</a></span></dt><dt><span class="sect2"><a href="#id901492">ALLHELP Setting</a></span></dt><dt><span class="sect2"><a href="#id901513">REVCQ Setting</a></span></dt><dt><span class="sect2"><a href="#id901549">CMDREPORT Setting</a></span></dt><dt><span class="sect2"><a href="#id901574">SERVICEUMODE Setting</a></span></dt><dt><span class="sect2"><a href="#id901600">SENDHELP Setting</a></span></dt><dt><span class="sect2"><a href="#id901627">SPLITTIME Setting</a></span></dt><dt><span class="sect2"><a href="#id901665">LOGLEVEL Setting</a></span></dt><dt><span class="sect2"><a href="#id901689">SERVICECMODE Setting</a></span></dt><dt><span class="sect2"><a href="#id901713">JOINSERVICESCHAN Setting</a></span></dt><dt><span class="sect2"><a href="#id901737">PINGTIME Setting</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id901756">Debugging Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id901766">DEBUGTOCHAN Setting</a></span></dt><dt><span class="sect2"><a href="#id901780">DEBUGMODULE Setting</a></span></dt><dt><span class="sect2"><a href="#id901793">DEBUGLEVEL Setting</a></span></dt></dl></dd></dl></div><p>The following Section describe NeoStats, or the Core to these
services</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id900310"></a>About NeoStats</h2></div></div></div><p>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.</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id900327"></a>Command Reference</h2></div></div></div><p>The Following are detailed Descriptions of the available
commands:</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900337"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg NeoStats HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p>Available to users if ONLY_OPERS not set in the configuration
file</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats HELP
/msg NeoStats HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900385"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg NeoStats version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current core version of NeoStats</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900424"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about NeoStats</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900464"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
NeoStats</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900503"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg NeoStats LEVELS LIST
/msg NeoStats LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900572"></a>LEVEL</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg NeoStats LEVEL &lt;nick&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats LEVEL</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900611"></a>STATUS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg NeoStats status</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats LEVEL</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900651"></a>SHUTDOWN</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg NeoStats SHUTDOWN &lt;reason&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Force NeoStats to exit immediately. This command should be used
wisely. </p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats SHUTDOWN upgrade</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900693"></a>RELOAD</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats RELOAD &lt;reason&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This command is not available on Windows Builds of
NeoStats</p></div><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats RELOAD Lagged</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900743"></a>LOAD</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats LOAD &lt;module&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Allows you to load a module while NeoStats is running. Some
modules can not be loaded at runtime, and will return an error.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats LOAD statserv</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900785"></a>UNLOAD</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats UNLOAD &lt;module&gt;</pre><p><span class="bold"><strong>Description:</strong></span></p><p>Allows you to unload a module while NeoStats is running. Some
modules can not be unloaded at runtime, and will return an
error</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats UNLOAD statserv</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900828"></a>MODLIST</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats MODLIST</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Display module names and descriptions of loaded modules</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats MODLIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900868"></a>RAW</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats RAW COMMAND</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Problems with RAW are NOT SUPPORTED.</p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats RAW COMMAND</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900932"></a>JUPE</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats JUPE Server
</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Allows you to jupe a server on the network</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats JUPE jupe.com</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id900971"></a>EXCLUDE</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats EXCLUDE LIST
/msg NeoStats EXCLUDE ADD &lt;HOST/SERVER/CHANNEL/USERHOST&gt; &lt;pattern&gt; &lt;reason&gt;
</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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. </p><p>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. </p><p>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. </p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats EXCLUDE LIST
/msg NeoStats EXCLUDE ADD HOST *.microsoft.com Microsoft Employes are not welcome here!
/msg NeoStats EXCLUDE DEL *.microsoft.com</pre></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id901035"></a>Debugging Command Reference</h2></div></div></div><p>The following Commands can assist you or developers to Debug
NeoStats</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901045"></a>USERLIST</h3></div></div></div><p><span class="bold"><strong> Syntax:</strong></span></p><pre class="screen">/msg NeoStats USERLIST [nick]</pre><p><span class="bold"><strong> Description:</strong></span></p><p>When in debug mode, Neostats will echo its user table to the
services channel. Only useful for debugging Neostats</p><p>If nick is passed, only the information of that nick is
returned, otherwise the entire user list is dumped.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats USERLIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901091"></a>CHANNELLIST</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats CHANNELLIST [channel]
</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats CHANNELLIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901136"></a>SERVERLIST</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span></p><pre class="screen">/msg NeoStats SERVERLIST</pre><p><span class="bold"><strong>Description: </strong></span></p><p>When in debug mode, Neostats will echo its server table to the
services channel. Only useful for debugging Neostats</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats SERVERLIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901175"></a>BANLIST</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span></p><pre class="screen">/msg NeoStats BANLIST</pre><p><span class="bold"><strong>Description: </strong></span></p><p>When in debug mode, Neostats will echo its network wide Ban List
(AKILLS, GLINES etc) to the services channel. Only useful for
debugging Neostats</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats BANLIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901215"></a>BOTLIST</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats BOTLIST</pre><p><span class="bold"><strong>Description: </strong></span> NeoStats will send you by notice
a list of the current bots being used on the network for each
module.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats BOTLIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901255"></a>SOCKLIST</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg NeoStats SOCKLIST</pre><p><span class="bold"><strong>Description</strong></span></p><p>NeoStats will send you by notice a list of the current sockets
being used on neostats for each module.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats SOCKLIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901297"></a>TIMERLIST</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg NeoStats TIMERLIST</pre><p><span class="bold"><strong>Description: </strong></span> NeoStats will
send you by notice a list of the current timer functions being used on
the network by each module.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg NeoStats TIMERLIST</pre></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id901340"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg NeoStats SET LIST
/msg NeoStats SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in NeoStats:</p><pre class="screen">CMDCHAR
MSGTHRESHOLD
MSGSAMPLETIME
DEBUGCHAN
ALLHELP
RECVQ
CMDREPORT
SERVICEUMODE
SENDHELP
SPLITTIME
LOGLEVEL
SERVICECMODE
JOINSERVICESCHAN
PINGTIME</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901380"></a>CMDCHAR Setting </h3></div></div></div><p>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 !&lt;command&gt;</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><p>This setting defaults to !</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901413"></a>MSGTHRESHOLD Setting</h3></div></div></div><p>NeoStats has inbuilt flood protection. This setting defines how
many messages NeoStats will allow in MSGSAMPLETIME (see below) before
ignoring or killing a user. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Operators are exempt from FloodProtection</p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><p>This setting defaults to 5 messages (in 30 Seconds, by default
for MSGSAMPLETIME)</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901446"></a>MSGSAMPLETIME Setting</h3></div></div></div><p>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.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><p>This setting defaults to 30 seconds</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901471"></a>DEBUGCHAN Setting</h3></div></div></div><p>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.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><p>This setting defaults to #DEBUG</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901492"></a>ALLHELP Setting</h3></div></div></div><p>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.</p><p>This setting defaults to disabled.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901513"></a>REVCQ Setting</h3></div></div></div><p>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.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Not all network communications are affected by this setting.
Consult the developers if you wish to know which modules might use
this settting.</p></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Changing this setting is not recommended unless you know what
you are doing!</p></div><p>This setting defaults to 2048 Bytes. </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901549"></a>CMDREPORT Setting</h3></div></div></div><p>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.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><p>This setting defaults to Enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901574"></a>SERVICEUMODE Setting</h3></div></div></div><p>This is the default User Mode assigned to all NeoStats bots. It
allows you to customize how the NeoStats Bots appear to end users.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects most NeoStats Bots. Some Bots do not use
this setting and may use a "per module" setting instead. </p></div><p>This setting defaults are dependant on the IRCd you connect
to.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901600"></a>SENDHELP Setting</h3></div></div></div><p>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.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><p>This setting defaults to enabled</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901627"></a>SPLITTIME Setting</h3></div></div></div><p>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. </p><p>A user is considered NetRiding if their Network Join Time is
older than the current time minus the SPLITTIME seconds. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p>This setting defaults to 300 Seconds</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901665"></a>LOGLEVEL Setting</h3></div></div></div><p>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.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><p>This setting defaults to 5 Seconds</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901689"></a>SERVICECMODE Setting</h3></div></div></div><p>This setting determines what channel modes NeoStats Bots will
get when joining channels. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects most NeoStats Bots. Those modules that
don't use this setting will have individual settings.</p></div><p>This setting is dependant on the IRCd being used.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901713"></a>JOINSERVICESCHAN Setting</h3></div></div></div><p>This setting determins if all NeoStats Bots should automatically
join the Services Channel.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This setting affects all NeoStats Bots</p></div><p>This setting defaults to enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901737"></a>PINGTIME Setting</h3></div></div></div><p>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.</p><p>This setting defaults to 120 seconds.</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id901756"></a>Debugging Settings Reference</h2></div></div></div><p>The following settings can assist you or developers to Debug
NeoStats</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901766"></a>DEBUGTOCHAN Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901780"></a>DEBUGMODULE Setting</h3></div></div></div><p>Filter the messages output to the debug channel by module. Eg,
you can specify that you only want debug messages for
SecureServ.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901793"></a>DEBUGLEVEL Setting</h3></div></div></div><p>What level of Debugging should be used.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id901806"></a>Chapter 6. StatServ</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id901817">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id901828">HELP</a></span></dt><dt><span class="sect2"><a href="#id901872">VERSION</a></span></dt><dt><span class="sect2"><a href="#id901911">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id901950">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id901990">LEVELS</a></span></dt><dt><span class="sect2"><a href="#id902054">CTCPVERSION</a></span></dt><dt><span class="sect2"><a href="#id902104">CHANNEL</a></span></dt><dt><span class="sect2"><a href="#id902191">SERVER</a></span></dt><dt><span class="sect2"><a href="#id902274">MAP</a></span></dt><dt><span class="sect2"><a href="#id902316">NETSTATS</a></span></dt><dt><span class="sect2"><a href="#id902357">DAILY</a></span></dt><dt><span class="sect2"><a href="#id902397">TLDMAP</a></span></dt><dt><span class="sect2"><a href="#id902440">OPERLIST</a></span></dt><dt><span class="sect2"><a href="#id902504">BOTLIST</a></span></dt><dt><span class="sect2"><a href="#id902543">FORCEHTML</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id902586">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id902623">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id902639">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id902655">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id902667">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id902680">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id902693">EXCLUSIONS Setting</a></span></dt><dt><span class="sect2"><a href="#id902709">RECORDALERT Setting</a></span></dt><dt><span class="sect2"><a href="#id902741">HTMLPATH Setting</a></span></dt><dt><span class="sect2"><a href="#id902767">HTMLTIME Setting</a></span></dt><dt><span class="sect2"><a href="#id902783">HTML Setting</a></span></dt><dt><span class="sect2"><a href="#id902798">CHANNELTIME Setting</a></span></dt><dt><span class="sect2"><a href="#id902816">MSGLIMIT Setting</a></span></dt><dt><span class="sect2"><a href="#id902834">MSGINTERVAL Setting</a></span></dt><dt><span class="sect2"><a href="#id902852">FLATMAP Setting</a></span></dt><dt><span class="sect2"><a href="#id902868">LAGTIME Setting</a></span></dt><dt><span class="sect2"><a href="#id902880">LAG Setting</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id902916">HTML Template Syntax</a></span></dt></dl></div><p>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.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id901817"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with StatServ.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901828"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg StatServ HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg StatServ HELP
/msg StatServ HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901872"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg StatServ version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of StatServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg StatServ VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901911"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg StatServ ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about StatServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg StatServ ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901950"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg StatServ CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
StatServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg StatServ CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id901990"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg StatServ LEVELS LIST
/msg StatServ LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg StatServ LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902054"></a>CTCPVERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span></p><pre class="screen">/msg StatServ CTCPVERSION &lt;limit&gt; </pre><p><span class="bold"><strong>Description:</strong></span></p><p>Provides Statistics on the Client Versions found</p><p>&lt;limit&gt; Specifies how many results to show. Results are
sorted by Most Popular to Least Popular</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg StatServ CTCPVERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902104"></a>CHANNEL</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span></p><pre class="screen">/msg StatServ CHANNEL &lt;POP/KICKS/TOPICS/&lt;Channame&gt;&gt;</pre><p><span class="bold"><strong>Description:</strong></span></p><p>Provides Statistics on Channels on the network</p><p><span class="emphasis"><em>CHAN </em></span></p><p>By itself provides a list of the top10 Channels based on the
current number of members</p><p><span class="emphasis"><em>CHAN POP </em></span></p><p>gives you information on the most popular channels on the
network based on the number of joins</p><p><span class="emphasis"><em>CHAN KICKS</em></span></p><p>Gives you the top 10 kicking channels</p><p><span class="emphasis"><em>CHAN TOPICS</em></span></p><p>Gives you the top10 Topic Changing Channels</p><p><span class="emphasis"><em>CHAN &lt;name&gt;</em></span></p><p>Gives you specific information on a channel</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg statserv chan #neostats</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902191"></a>SERVER</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span></p><pre class="screen">/msg StatServ SERVER &lt;&lt;server name&gt;/LIST/DEL/RENAME&gt; &lt;oldserver&gt; &lt;newserver&gt;</pre><p><span class="bold"><strong>Description:</strong></span></p><p>Allows you to view and modify server statistics. </p><p><span class="emphasis"><em>SERVER &lt;servername&gt;</em></span></p><p>Allows you to view statistics about a particular server</p><p><span class="emphasis"><em>SERVER LIST</em></span></p><p>Shows all the server entries stored in StatServ's
Database.</p><p><span class="emphasis"><em>SERVER DEL</em></span></p><p>Delete a server entry stored in StatServ's Database.</p><p><span class="emphasis"><em>SERVER RENAME &lt;oldserver&gt;
&lt;newserver&gt;</em></span></p><p>Rename a server entry stored in StatServ's Database.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg statserv server rollergirl.sg.as.irc-chat.net</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902274"></a>MAP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg StatServ MAP</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Provides a server listing with minimal statistics.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg StatServ MAP</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902316"></a>NETSTATS</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg StatServ NETSTATS</pre><p><span class="bold"><strong> Description</strong></span></p><p>Provides information about the performance of the
network.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg StatServ NETSTATS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902357"></a>DAILY</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg StatServ DAILY </pre><p><span class="bold"><strong>Description:</strong></span></p><p>Provides information about records that have been set
today.</p><p><span class="bold"><strong>Example:</strong></span> </p><pre class="screen">/msg StatServ DAILY</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902397"></a>TLDMAP</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg StatServ TLDMAP </pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows the network map in relation to top level domains.</p><p><span class="bold"><strong>Example: </strong></span></p><pre class="screen">/msg StatServ TLDMAP</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902440"></a>OPERLIST</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg StatServ OPERLIST &lt;NOAWAY/&lt;server_name&gt;&gt; </pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a listing of IRCops.</p><p>Flags:</p><p><span class="emphasis"><em>NOAWAY</em></span></p><p>Don't show opers that are set away.</p><p><span class="emphasis"><em>SERVER</em></span></p><p>Only show opers on that server.</p><p><span class="bold"><strong>Example: </strong></span></p><pre class="screen">/msg statserv operlist
/msg statserv operlist noaway
/msg statserv operlist &lt;server&gt;</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902504"></a>BOTLIST</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg StatServ BOTLIST </pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows all current bots on the network. (umode +B users if your
IRCD supports Umode +B)</p><p><span class="bold"><strong>Example: </strong></span></p><pre class="screen">/msg StatServ BOTLIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902543"></a>FORCEHTML</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg StatServ FORCEHTML </pre><p><span class="bold"><strong>Description: </strong></span></p><p>Forces an update of the HTML data file with the most current
network statistics.</p><p><span class="bold"><strong>Example: </strong></span></p><pre class="screen">/msg StatServ FORCEHTML</pre></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id902586"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg StatServ SET LIST
/msg StatServ SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in StatServ:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
RECORDALERT
HTMLPATH
HTMLTIME
HTML
CHANNELTIME
MSGLIMIT
MSGINTERVAL
FLATMAP
LAGTIME
LAGALERT</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902623"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the StatServ module
uses for the Bot. </p><p>This setting defaults to "StatServ"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902639"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the StatServ module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "StatServ1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902655"></a>USER Setting</h3></div></div></div><p>The "User" that the StatServ bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902667"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that StatServ will use when
signon to the network. If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902680"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902693"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if StatServ should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902709"></a>RECORDALERT Setting</h3></div></div></div><p>This setting determines if StatServ should broadcast new records
on the network (such as Max no of users etc). The options are:</p><p>0 - Never</p><p>1 - Announce in services channel </p><p>2 - Announce by globops </p><p>3 - Announce by wallops</p><p>This setting defaults to 1 - Announce in services channel</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902741"></a>HTMLPATH Setting</h3></div></div></div><p>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. </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>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:</p><p>/home/fish/public_html/networkstats.html</p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902767"></a>HTMLTIME Setting</h3></div></div></div><p>How often StatServ should update the HTML file specified in
HTMLPATH if HTML is enabled (See HTML setting)</p><p>This defaults to 3600 seconds</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902783"></a>HTML Setting</h3></div></div></div><p>Should StatServ automatically update the HTML file.</p><p>This defaults to Disabled</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902798"></a>CHANNELTIME Setting</h3></div></div></div><p>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.</p><p>This setting defaults to 604800 Seconds</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902816"></a>MSGLIMIT Setting</h3></div></div></div><p>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. </p><p>This setting defaults to 5</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902834"></a>MSGINTERVAL Setting</h3></div></div></div><p>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.</p><p>This setting defaults to 60 Seconds</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902852"></a>FLATMAP Setting</h3></div></div></div><p>This option causes the MAP command to become flat, thus not
showing the real structure of your IRC network to users.</p><p>This setting defaults to disabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902868"></a>LAGTIME Setting</h3></div></div></div><p>This settting determines how lagged a server should be for
StatServ to consider that server lagged out. </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id902880"></a>LAG Setting</h3></div></div></div><p>This setting determins if StatServ should broadcast a message
when a servers pingtime exceeds the LAGTIME specified above.</p><p>Options are: </p><p>0 - Never </p><p>1 - Announce in services channel </p><p>2 - Announce by globops </p><p>3 - Announce by wallops</p><p>This setting defaults to 1 - Announce in services channel</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id902916"></a>HTML Template Syntax</h2></div></div></div><p>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 !</p><p>The available template variables are:</p><p><span class="bold"><strong>!MAP!</strong></span> -Outputs a network</p><p>Map similar to /msg statserv map in a table format</p><p><span class="bold"><strong>!SRVLIST! </strong></span>-Outputs a complete
list of servers that StatServ has ever seen, which are linked to
detailed server information provided by the template variable
!SRVLISTDET!</p><p><span class="bold"><strong>!SRVLISTDET! </strong></span>-Outputs detailed
server information</p><p>see also !SRVLIST!</p><p><span class="bold"><strong>!NETSTATS! </strong></span>-Outputs Network
Statistics</p><p>similar to /msg statserv netstats</p><p><span class="bold"><strong>!DAILYSTATS! </strong></span>-Outputs the Daily
Statistics</p><p>similar to /msg statserv daily</p><p><span class="bold"><strong>!DAILYTOPCHAN! </strong></span>-Outputs the top10
channels based on number of members</p><p><span class="bold"><strong>!TOP10CHAN! </strong></span>-Outputs the top10
channels ever based on number of joins</p><p><span class="bold"><strong>!TOP10KICKS! </strong></span>-Outputs the top10
kicking channels</p><p><span class="bold"><strong>!TOP10TOPICS! </strong></span>-Outputs the top10
topic changing channels</p><p><span class="bold"><strong>!TLDMAP! </strong></span>-Outputs the TLD
map</p><p>similar to /msg statserv tldmap</p><p><span class="bold"><strong>!VERSION! </strong></span>-Outputs the version of
NeoStats</p><p><span class="bold"><strong>!TITLE! </strong></span>-Outputs title in the
form: "Network Statistics for YourNetName"</p><p><span class="bold"><strong>!CLIENTSTATS! </strong></span>-Outputs Top 10
clients used on the network. (Requires SecureServ module with version
checks enabled).</p><p>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!)</p><p>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.</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id903086"></a>Chapter 7. ConnectServ</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id903100">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id903110">HELP</a></span></dt><dt><span class="sect2"><a href="#id903154">VERSION</a></span></dt><dt><span class="sect2"><a href="#id903193">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id903233">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id903272">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id903342">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id903378">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id903393">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id903410">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id903422">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id903434">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id903448">EXCLUSIONS Setting</a></span></dt><dt><span class="sect2"><a href="#id903464">LOGGING Setting</a></span></dt><dt><span class="sect2"><a href="#id903480">KILLWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903495">SERVWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903510">NICKWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903525">SIGNWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903541">MODEWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903557">AWAYWATCH Setting</a></span></dt><dt><span class="sect2"><a href="#id903572">COLOUR Setting</a></span></dt></dl></dd></dl></div><p>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.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id903100"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with ConnectServ.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903110"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg ConnectServ HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ConnectServ HELP
/msg ConnectServ HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903154"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg ConnectServ version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of ConnectServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ConnectServ VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903193"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg ConnectServ ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about ConnectServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ConnectServ ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903233"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg ConnectServ CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
ConnectServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ConnectServ CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903272"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg ConnectServ LEVELS LIST
/msg ConnectServ LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for
a example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ConnectServ LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id903342"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ConnectServ SET LIST
/msg ConnectServ SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in ConnectServ:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
LOGGING
KILLWATCH
SERVWATCH
NICKWATCH
SIGNWATCH
MODEWATCH
AWAYWATCH
COLOUR
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903378"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the ConnectServ
module uses for the Bot.</p><p>This setting defaults to "ConnectServ"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903393"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the ConnectServ
module uses for the Bot if the Primary Nickname is not
available</p><p>This setting defaults to "ConnectServ1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903410"></a>USER Setting</h3></div></div></div><p>The "User" that the ConnectServ bot will signon to the network
as (Ident). If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903422"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that ConnectServ will use
when signon to the network. If not specified, uses the same as the
NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903434"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903448"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if ConnectServ should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903464"></a>LOGGING Setting</h3></div></div></div><p>This setting determins if ConnectServ should also log all
notices to the LogFile in addition to the services channel.</p><p>This setting defaults to Enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903480"></a>KILLWATCH Setting</h3></div></div></div><p>Should ConnnectServ broadcast out Global Kills on the
network.</p><p>This setting defaults to Enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903495"></a>SERVWATCH Setting</h3></div></div></div><p>Should ConnectServ broadcast out Server Joins and Splits on the
network</p><p>This defaults to Enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903510"></a>NICKWATCH Setting</h3></div></div></div><p>Should ConnectServ broadcast out Nickname Changes on the
network</p><p>This defaults to Enabled</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903525"></a>SIGNWATCH Setting</h3></div></div></div><p>Should ConnectServ broadcast out Users connecting and
disconnnecting on the network</p><p>This setting defaults to Enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903541"></a>MODEWATCH Setting</h3></div></div></div><p>Should ConnectServ broadcast out User Mode Changes on the
network</p><p>This setting defaults to Enabled</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903557"></a>AWAYWATCH Setting</h3></div></div></div><p>Should ConnectServ broadcast out Users going away and comming
back on the network</p><p>This setting defaults to Enabled</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903572"></a>COLOUR Setting</h3></div></div></div><p>Should the messages logged to the channel be in colour or
standard.</p><p>This setting defaults to disabled.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id903590"></a>Chapter 8. HostServ</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id903603">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id903613">HELP</a></span></dt><dt><span class="sect2"><a href="#id903657">VERSION</a></span></dt><dt><span class="sect2"><a href="#id903697">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id903736">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id903776">LEVELS</a></span></dt><dt><span class="sect2"><a href="#id903844">ADD</a></span></dt><dt><span class="sect2"><a href="#id903883">DEL</a></span></dt><dt><span class="sect2"><a href="#id903928">LIST</a></span></dt><dt><span class="sect2"><a href="#id903970">VIEW</a></span></dt><dt><span class="sect2"><a href="#id904008">LOGIN</a></span></dt><dt><span class="sect2"><a href="#id904050">BANS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id904115">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id904152">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id904168">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id904184">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id904196">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id904209">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id904222">EXCLUSIONS Setting</a></span></dt><dt><span class="sect2"><a href="#id904238">VERBOSE Setting</a></span></dt><dt><span class="sect2"><a href="#id904254">HIDDENHOST Setting</a></span></dt><dt><span class="sect2"><a href="#id904277">HOSTNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id904293">OPERHOST Setting</a></span></dt><dt><span class="sect2"><a href="#id904314">ADDLEVEL Setting</a></span></dt><dt><span class="sect2"><a href="#id904329">EXPIRE Setting</a></span></dt></dl></dd></dl></div><p>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.</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id903603"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with HostServ.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903613"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg HostServ HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ HELP
/msg HostServ HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903657"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg HostServ version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of HostServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903697"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg HostServ ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about HostServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903736"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg HostServ CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
HostServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903776"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg HostServ LEVELS LIST
/msg HostServ LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903844"></a>ADD</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg HostServ ADD &lt;NICK&gt; &lt;HOST NAME&gt; &lt;VIRTUAL HOST NAME&gt; &lt;PASSWORD&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Adds a entry to the HostServ Database for a specified User.
</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ ADD neo aol.com coolhost.com mypassword</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903883"></a>DEL</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg HostServ DEL &lt;ACCESS LIST #&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Deletes a VHOST entry from the HostServ Database. &lt;ACCESS
LIST #&gt; can be obtained by using the LIST command.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ DEL 1</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903928"></a>LIST</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg HostServ LIST &lt;start&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Lists the people and vhosts in the Database. Only lists a maxium
of 20 entries if &lt;start&gt; is specified, start the listing at
number &lt;start&gt;</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ LIST</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id903970"></a>VIEW</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg HostServ VIEW &lt;ACCESS LIST #&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>View Detailed information about the vhost on the list # you
selected</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ VIEW 1</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904008"></a>LOGIN</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg HostServ LOGIN &lt;NICK&gt; &lt;PASSWORD&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Login to HostServ with your NICK and PASSWORD and your vhost
will be assigned to your nick on successful login.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ LOGIN Angel Password</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904050"></a>BANS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg HostServ BANS [[add/del] &lt;option&gt;]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Controls the vhost banned list entries: </p><p>BANS lists current vhosts that are banned by network
administration. </p><p>The following options are only available to Network
Administration: </p><p>BANS add &lt;wildcard&gt; Add a banned vhost to the list
Wildcards, like *fbi* are permitted. </p><p>BANS del # Delete a banned vhost with ID number # </p><p>You may figure out the ID number by using BANS by itself</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ BANS add microsoft.com</pre></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id904115"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg HostServ SET LIST
/msg HostServ SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in HostServ:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
VERBOSE
HIDDENHOST
HOSTNAME
OPERHOSTS
ADDLEVEL
EXPIRE</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904152"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the HostServ module
uses for the Bot.</p><p>This setting defaults to "HostServ"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904168"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the HostServ module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "HostServ1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904184"></a>USER Setting</h3></div></div></div><p>The "User" that the HostServ bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904196"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that HostServ will use when
signon to the network. If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904209"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904222"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if HostServ should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904238"></a>VERBOSE Setting</h3></div></div></div><p>This setting determins if HostServ should broadcast all actions
that HostServ performs, such as setting users VHOSTS etc.</p><p>This setting defaults to Enabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904254"></a>HIDDENHOST Setting</h3></div></div></div><p>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 &lt;user&gt;.user.HOSTNAME</p><p>This setting defaults to Disabled.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904277"></a>HOSTNAME Setting</h3></div></div></div><p>Determines the Domain Name to use when setting users Hosts or
Opers Hosts if HiddenHost or OperHost is enabled. </p><p>This has no default</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904293"></a>OPERHOST Setting</h3></div></div></div><p>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
&lt;user&gt;.oper.HOSTNAME</p><p>This defaults to Disabled</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904314"></a>ADDLEVEL Setting</h3></div></div></div><p>The Level that is required to use the Add Command to create new
VHOSTS for other users.</p><p>This setting defaults to 40</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904329"></a>EXPIRE Setting</h3></div></div></div><p>Should HostServ expire un-used entries after a period of time.
Setting is specified as Days. if 0 is specified, makes all VHOSTS
permanent</p><p>This setting defaults to 60 Days</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id904348"></a>Chapter 9. LimitServ</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id904357">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id904368">HELP</a></span></dt><dt><span class="sect2"><a href="#id904412">VERSION</a></span></dt><dt><span class="sect2"><a href="#id904451">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id904490">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id904530">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id904596">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id904630">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id904645">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id904662">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id904674">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id904686">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id904700">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></div><p>LimitServ is designed to ....</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id904357"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with LimitServ.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904368"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg LimitServ HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg LimitServ HELP
/msg LimitServ HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904412"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg LimitServ version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of LimitServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg LimitServ VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904451"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg LimitServ ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about LimitServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg LimitServ ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904490"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg LimitServ CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
LimitServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg LimitServ CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904530"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg LimitServ LEVELS LIST
/msg LimitServ LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg LimitServ LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id904596"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg LimitServ SET LIST
/msg LimitServ SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in LimitServ:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904630"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the LimitServ module
uses for the Bot.</p><p>This setting defaults to "LimitServ"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904645"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the LimitServ module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "LimitServ1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904662"></a>USER Setting</h3></div></div></div><p>The "User" that the LimitServ bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904674"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that LimitServ will use
when signon to the network. If not specified, uses the same as the
NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904686"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904700"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if LimitServ should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id904718"></a>Chapter 10. OperLog</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id904727">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id904737">HELP</a></span></dt><dt><span class="sect2"><a href="#id904781">VERSION</a></span></dt><dt><span class="sect2"><a href="#id904821">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id904860">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id904900">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id904969">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905003">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905018">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905034">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id905046">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id905059">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id905072">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></div><p>OperLog is designed to ....</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id904727"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with OperLog.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904737"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg OperLog HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg OperLog HELP
/msg OperLog HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904781"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg OperLog version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of OperLog</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg OperLog VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904821"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg OperLog ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about OperLog</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg OperLog ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904860"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg OperLog CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
OperLog</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg OperLog CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id904900"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg OperLog LEVELS LIST
/msg OperLog LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg OperLog LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id904969"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg OperLog SET LIST
/msg OperLog SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in OperLog:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905003"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the OperLog module
uses for the Bot.</p><p>This setting defaults to "OperLog"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905018"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the OperLog module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "OperLog1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905034"></a>USER Setting</h3></div></div></div><p>The "User" that the OperLog bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905046"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that OperLog will use when
signon to the network. If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905059"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905072"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if OperLog should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id905090"></a>Chapter 11. QuoteServ</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id905100">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905110">HELP</a></span></dt><dt><span class="sect2"><a href="#id905154">VERSION</a></span></dt><dt><span class="sect2"><a href="#id905193">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id905232">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id905272">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id905341">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905376">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905391">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905407">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id905419">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id905432">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id905445">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></div><p>QuoteServ is designed to ....</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id905100"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with QuoteServ.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905110"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg QuoteServ HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg QuoteServ HELP
/msg QuoteServ HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905154"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg QuoteServ version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of QuoteServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg QuoteServ VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905193"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg QuoteServ ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about QuoteServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg QuoteServ ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905232"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg QuoteServ CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
QuoteServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg QuoteServ CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905272"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg QuoteServ LEVELS LIST
/msg QuoteServ LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg QuoteServ LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id905341"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg QuoteServ SET LIST
/msg QuoteServ SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in QuoteServ:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905376"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the QuoteServ module
uses for the Bot.</p><p>This setting defaults to "QuoteServ"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905391"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the QuoteServ module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "QuoteServ1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905407"></a>USER Setting</h3></div></div></div><p>The "User" that the QuoteServ bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905419"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that QuoteServ will use
when signon to the network. If not specified, uses the same as the
NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905432"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905445"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if QuoteServ should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id905463"></a>Chapter 12. TextServ</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id905472">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905482">HELP</a></span></dt><dt><span class="sect2"><a href="#id905527">VERSION</a></span></dt><dt><span class="sect2"><a href="#id905566">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id905605">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id905645">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id905714">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905748">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905764">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id905780">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id905792">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id905805">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id905818">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></div><p>TextServ is designed to ....</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id905472"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with TextServ.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905482"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg TextServ HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg TextServ HELP
/msg TextServ HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905527"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg TextServ version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of TextServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg TextServ VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905566"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg TextServ ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about TextServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg TextServ ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905605"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg TextServ CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
TextServ</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg TextServ CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905645"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg TextServ LEVELS LIST
/msg TextServ LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg TextServ LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id905714"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg TextServ SET LIST
/msg TextServ SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in TextServ:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905748"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the TextServ module
uses for the Bot.</p><p>This setting defaults to "TextServ"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905764"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the TextServ module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "TextServ1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905780"></a>USER Setting</h3></div></div></div><p>The "User" that the TextServ bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905792"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that TextServ will use when
signon to the network. If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905805"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905818"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if TextServ should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id905836"></a>Chapter 13. ExtAuth</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id905845">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id905855">HELP</a></span></dt><dt><span class="sect2"><a href="#id905900">VERSION</a></span></dt><dt><span class="sect2"><a href="#id905939">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id905978">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id906018">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id906087">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906121">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906136">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906152">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id906165">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id906177">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id906190">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></div><p>ExtAuth is designed to ....</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id905845"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with ExtAuth.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905855"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg ExtAuth HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ExtAuth HELP
/msg ExtAuth HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905900"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg ExtAuth version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of ExtAuth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ExtAuth VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905939"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg ExtAuth ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about ExtAuth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ExtAuth ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id905978"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg ExtAuth CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
ExtAuth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ExtAuth CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906018"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg ExtAuth LEVELS LIST
/msg ExtAuth LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ExtAuth LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id906087"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg ExtAuth SET LIST
/msg ExtAuth SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in ExtAuth:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906121"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the ExtAuth module
uses for the Bot.</p><p>This setting defaults to "ExtAuth"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906136"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the ExtAuth module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "ExtAuth1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906152"></a>USER Setting</h3></div></div></div><p>The "User" that the ExtAuth bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906165"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that ExtAuth will use when
signon to the network. If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906177"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906190"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if ExtAuth should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id906208"></a>Chapter 14. IRCDAuth</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id906218">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906228">HELP</a></span></dt><dt><span class="sect2"><a href="#id906272">VERSION</a></span></dt><dt><span class="sect2"><a href="#id906311">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id906350">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id906390">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id906460">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906494">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906509">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906525">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id906537">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id906550">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id906563">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></div><p>IRCDAuth is designed to ....</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id906218"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with IRCDAuth.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906228"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg IRCDAuth HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg IRCDAuth HELP
/msg IRCDAuth HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906272"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg IRCDAuth version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of IRCDAuth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg IRCDAuth VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906311"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg IRCDAuth ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about IRCDAuth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg IRCDAuth ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906350"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg IRCDAuth CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
IRCDAuth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg IRCDAuth CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906390"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg IRCDAuth LEVELS LIST
/msg IRCDAuth LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg IRCDAuth LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id906460"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg IRCDAuth SET LIST
/msg IRCDAuth SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in IRCDAuth:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906494"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the IRCDAuth module
uses for the Bot.</p><p>This setting defaults to "IRCDAuth"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906509"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the IRCDAuth module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "IRCDAuth1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906525"></a>USER Setting</h3></div></div></div><p>The "User" that the IRCDAuth bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906537"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that IRCDAuth will use when
signon to the network. If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906550"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906563"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if IRCDAuth should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id906581"></a>Chapter 15. Writting Modules</h2></div></div></div><p>...</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id906591"></a>Chapter 16. Wirring Perl Modules</h2></div></div></div><p>...</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id906601"></a>Chapter 17. Writting C Modules: template</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id906611">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906621">HELP</a></span></dt><dt><span class="sect2"><a href="#id906665">VERSION</a></span></dt><dt><span class="sect2"><a href="#id906705">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id906744">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id906784">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id906853">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906887">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906902">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id906918">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id906931">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id906943">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id906956">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></div><p>template is designed to ....</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id906611"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with template.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906621"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg template HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg template HELP
/msg template HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906665"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg template version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of template</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg template VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906705"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg template ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about template</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg template ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906744"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg template CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
template</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg template CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906784"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg template LEVELS LIST
/msg template LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for a
example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg template LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id906853"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg template SET LIST
/msg template SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in template:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906887"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the template module
uses for the Bot.</p><p>This setting defaults to "template"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906902"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the template module
uses for the Bot if the Primary Nickname is not available</p><p>This setting defaults to "template1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906918"></a>USER Setting</h3></div></div></div><p>The "User" that the template bot will signon to the network as
(Ident). If not specified, uses the same as the NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906931"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that template will use when
signon to the network. If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906943"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906956"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if template should use the Global Exclusion List
maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id906974"></a>Chapter 18. Writting Authentication Modules: templateauth</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id906985">Command Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id906995">HELP</a></span></dt><dt><span class="sect2"><a href="#id907040">VERSION</a></span></dt><dt><span class="sect2"><a href="#id907079">ABOUT</a></span></dt><dt><span class="sect2"><a href="#id907118">CREDITS</a></span></dt><dt><span class="sect2"><a href="#id907158">LEVELS</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id907228">Settings Reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id907262">NICK Setting</a></span></dt><dt><span class="sect2"><a href="#id907278">ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#id907294">USER Setting</a></span></dt><dt><span class="sect2"><a href="#id907307">HOST Setting</a></span></dt><dt><span class="sect2"><a href="#id907320">REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#id907333">EXCLUSIONS Setting</a></span></dt></dl></dd></dl></div><p>templateauth is designed to ....</p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id906985"></a>Command Reference</h2></div></div></div><p>The following Commands may be used with templateauth.</p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id906995"></a>HELP</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg templateauth HELP [command]</pre><p><span class="bold"><strong>Description: </strong></span></p><p>HELP displays available commands</p><p>HELP COMMAND will display help for that command and the syntax
you should use.</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg templateauth HELP
/msg templateauth HELP INFO</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907040"></a>VERSION</h3></div></div></div><p><span class="bold"><strong>Syntax:</strong></span> </p><pre class="screen">/msg templateauth version</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Displays the current version of templateauth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg templateauth VERSION</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907079"></a>ABOUT</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg templateauth ABOUT</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows a descriptive text about templateauth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg templateauth ABOUT</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907118"></a>CREDITS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span> </p><pre class="screen">/msg templateauth CREDITS</pre><p><span class="bold"><strong>Description: </strong></span></p><p>Shows details about the Authors and Contributors of
templateauth</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg templateauth CREDITS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907158"></a>LEVELS</h3></div></div></div><p><span class="bold"><strong>Syntax: </strong></span></p><pre class="screen">/msg templateauth LEVELS LIST
/msg templateauth LEVELS &lt;command&gt; &lt;newlevel&gt;</pre><p><span class="bold"><strong>Description: </strong></span></p><p>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.</p><p>/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 &lt;command&gt; &lt;newlevel&gt; syntax. See below for
a example</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>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.</p></div><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg templateauth LEVELS HELP 200</pre><p>This
sets the help command to only be available to users with Level 200 or
above (not very usefull though!)</p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id907228"></a>Settings Reference</h2></div></div></div><p>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:</p><p><span class="bold"><strong>Example:</strong></span></p><pre class="screen">/msg templateauth SET LIST
/msg templateauth SET &lt;option&gt; &lt;paramater&gt;</pre><p>The Following Settings are available in templateauth:</p><pre class="screen">NICK
ALTNICK
USER
HOST
REALNAME
EXCLUSIONS
</pre><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907262"></a>NICK Setting</h3></div></div></div><p>This setting is to change the nickname that the templateauth
module uses for the Bot.</p><p>This setting defaults to "templateauth"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907278"></a>ALTNICK Setting</h3></div></div></div><p>This setting is to change the nickname that the templateauth
module uses for the Bot if the Primary Nickname is not
available</p><p>This setting defaults to "templateauth1"</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907294"></a>USER Setting</h3></div></div></div><p>The "User" that the templateauth bot will signon to the network
as (Ident). If not specified, uses the same as the NeoStats
Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907307"></a>HOST Setting</h3></div></div></div><p>This setting determines the hostname that templateauth will use
when signon to the network. If not specified, uses the same as the
NeoStats Bot.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907320"></a>REALNAME Setting</h3></div></div></div><p>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.</p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id907333"></a>EXCLUSIONS Setting</h3></div></div></div><p>This setting if templateauth should use the Global Exclusion
List maintained by the Main NeoStats Bot.</p><p>This setting defaults to enabled.</p></div></div></div></div></body></html>