50 lines
23 KiB
HTML
50 lines
23 KiB
HTML
|
<html><head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
|
|
<title>ModuleName 3.0 Manual</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e1"></a>ModuleName 3.0 Manual</h2></div></div><hr></div><div class="toc"><dl><dt><span class="sect1"><a href="#d0e10">1. Prerequisites and Installation.</a></span></dt><dd><dl><dt><span class="sect2"><a href="#d0e42">1.1. Compiling and Installation</a></span></dt></dl></dd><dt><span class="sect1"><a href="#d0e90">2. Basic Configuration</a></span></dt><dd><dl><dt><span class="sect2"><a href="#d0e107">2.1. Blah Blah</a></span></dt><dt><span class="sect2"><a href="#d0e112">2.2. Blah Blah</a></span></dt></dl></dd><dt><span class="sect1"><a href="#d0e117">3. Detailed Configuration</a></span></dt><dd><dl><dt><span class="sect2"><a href="#d0e156">3.1. NICK Setting</a></span></dt><dt><span class="sect2"><a href="#d0e166">3.2. ALTNICK Setting</a></span></dt><dt><span class="sect2"><a href="#d0e176">3.3. USER Setting</a></span></dt><dt><span class="sect2"><a href="#d0e186">3.4. HOST Setting</a></span></dt><dt><span class="sect2"><a href="#d0e196">3.5. REALNAME Setting</a></span></dt><dt><span class="sect2"><a href="#d0e206">3.6. EXCLUSIONS Setting</a></span></dt><dt><span class="sect2"><a href="#d0e218">3.7. BLAH Blah Setting</a></span></dt></dl></dd><dt><span class="sect1"><a href="#d0e227">4. Operational Commands</a></span></dt><dd><dl><dt><span class="sect2"><a href="#d0e261">4.1. HELP Command</a></span></dt><dt><span class="sect2"><a href="#d0e272">4.2. VERSION Command</a></span></dt><dt><span class="sect2"><a href="#d0e281">4.3. ABOUT Command</a></span></dt><dt><span class="sect2"><a href="#d0e290">4.4. CREDITS Command</a></span></dt><dt><span class="sect2"><a href="#d0e299">4.5. LEVELS Command</a></span></dt><dt><span class="sect2"><a href="#d0e320">4.6. SET Command</a></span></dt><dt><span class="sect2"><a href="#d0e325">4.7. EXCLUDE Command</a></span></dt><dt><span class="sect2"><a href="#d0e395">4.8. BLAHBLAH Command</a></span></dt></dl></dd><dt><span class="sect1"><a href="#d0e410">5. Optional Chapter</a></span></dt><dd><dl><dt><span class="sect2"><a href="#d0e415">5.1. Optional Sub Heading</a></span></dt><dd><dl><dt><span class="sect3"><a href="#d0e420">5.1.1. Minor heading</a></span></dt></dl></dd></dl></dd></dl></div><p>Welcome to the ModuleName Manual. This document will aid you in setting up and running ModuleName on your IRC network.</p><p><add module introduction></p><p>ModuleName is Copyright, 2006 by Justin Hammond.</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e10"></a>1. Prerequisites and Installation.</h2></div></div></div><p>ModuleName is designed to run on Top of NeoStats. The Following requirements at the time of writing are required for NeoStats:</p><div class="itemizedlist"><ul type="disc"><li><p>A Linux or BSD based Server or Shell.</p></li><li><p>A IRCd supported by NeoStats. See the <a href="#">NeoStats</a> website.</p></li><li><p>Some basic Unix administration Skill</p></li><li><p>Of Course, a IRC network to connect it all together.</p></li></ul></div><p>Please refer to the NeoStats website for more information on the requirements</p><p>ModuleName itself requires the following:</p><div class="itemizedlist"><ul type="disc"><li><p>NeoStats 3.0 or Higher correctly installed and Running</p></li><li><p>The time to read this entire document. </p></li></ul></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e42"></a>1.1. Compiling and Installation</h3></div></div></div><p>As long as you have successfully setup NeoStats, and installed it correctly, Compiling ModuleName is very simple and straight forward. First you must extract the files from the download package. This is as simple as:</p><pre class="screen">bash$<span><strong class="command"> ta
|
||
|
|
checking whether to enable maintainer-specific portions of Makefiles... no
|
||
|
|
checking for a BSD-compatible install... /usr/bin/install -c
|
||
|
|
checking whether build environment is sane... yes
|
||
|
|
checking for gawk... no
|
||
|
|
checking for mawk... no
|
||
|
|
checking for nawk... no
|
||
|
|
|
||
|
|
<snip>
|
||
|
|
|
||
|
|
checking To Enable AutoTools Debug Mode?... no
|
||
|
|
checking silent building of source files... Enabled
|
||
|
|
configure: creating ./config.status
|
||
|
|
config.status: creating Makefile
|
||
|
|
config.status: creating modconfig.h
|
||
|
|
config.status: modconfig.h is unchanged
|
||
|
|
config.status: executing depfiles commands
|
||
|
|
Configuration complete.
|
||
|
|
Press Enter key to read the release notes</pre><p>The Configure process will then prompt you to read the release notes. You are encouraged to read this document throughly as it might contain important information about the current version of ModuleName that isn't covered in the manual.</p><p>If the configuration did not produce a error, you may then move onto Compiling ModuleName. Compiling is simply just issuing the "make" command (or "gmake" if you are running BSD):</p><pre class="screen">Fishs-Mac:~/Documents/Dev/ModuleName justin$ make
|
||
|
|
make -s all-am
|
||
|
|
Compiling Helpers.c: [OK]
|
||
|
|
Compiling ModuleName.c: [OK]
|
||
|
|
Compiling scan.c: [OK]
|
||
|
|
Compiling OnJoinBot.c: [OK]
|
||
|
|
Compiling ModuleName_help.c: [OK]
|
||
|
|
Compiling update.c: [OK] </pre><p>Again, check for Error messages. As long as there are not error messages, "make install" will install ModuleName, this README file, and any auxiliary files needed into your NeoStats directory:</p><pre class="screen">Fishs-Mac:~/Documents/Dev/ModuleName justin$ make install
|
||
|
|
Installing ModuleName.so: [OK]
|
||
|
|
Installing viri.dat: [OK]
|
||
|
|
Installing README.ModuleName: [OK]
|
||
|
|
Installing README.ModuleName.html: [OK] </pre><p>If you receive *ANY* errors at all during the this process, please post them on our Support boards, at http//www.neostats.net/boards/</p><p>Once Installation is complete, you can either configure NeoStats to load ModuleName when it starts, or load ModuleName via IRC.</p><p>To Configure NeoStats to automatically load ModuleName when it boots, modify the neostats.conf file and add ModuleName to the list of modules to load:</p><pre class="screen">MODULENAME = {
|
||
|
|
"statserv",
|
||
|
|
"hostserv",
|
||
|
|
"ModuleName",
|
||
|
|
} </pre><p>To load ModuleName via IRC, you must make sure you have the appropriate permissions and issue the following command:</p><p><span><strong class="command">/msg neostats load ModuleName</strong></span></p><p>Thats it. ModuleName is now loaded and ready for use (in fact, it will already be running now, but read on for further information.)</p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e90"></a>2. Basic Configuration</h2></div></div></div><p>ModuleName is completely configured online via IRC. When you first start up ModuleName, it attempts some "Sane" defaults for you get started with, but you should always review these settings as soon as you install. There are a few important settings you may want to review right away. They are:</p><div class="itemizedlist"><ul type="disc"><li><p>blah blah</p></li><li><p>blah blah</p></li><li><p>blah blah</p></li></ul></div><p>These are outlined below:</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e107"></a>2.1. Blah Blah</h3></div></div></div><p>Blah Blah</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e112"></a>2.2. Blah Blah</h3></div></div></div><p>BLAH BLAH</p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e117"></a>3. Detailed Configuration</h2></div></div></div><p>ModuleName attempts to be as configurable as possible in order to cater for each individual networks requirements. This in turn though makes the configuration very complex. There are many many settings with ModuleName that affect how it operates, how it responds and even, how affects the performance of NeoStats Overall. Out of the box, ModuleName provides sensible defaults for these settings, but you may wish to read this section for details on exactly what each option does, and its affect on how ModuleName operates.</p><p>The following list summaries the available options you can set in ModuleName</p><div class="itemizedlist"><ul type="disc"><li><p>NICK</p></li><li><p>ALTNICK</p></li><li><p>USER</p></li><li><p>HOST</p></li><li><p>REALNAME</p></li><li><p>EXCLUSIONS</p></li><li><p>BLAHBLAH</p></li></ul></div><p>To change any of these settings, you use the Set Interface in ModuleName. Eg:</p><pre class="screen">/msg ModuleName set <option> <params></pre><p>To view the current settings, issue the following command:</p><pre class="screen">/msg ModuleName set list</pre><p>The following Sections describes the different options, their params, and the effect on ModuleName in detail.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e156"></a>3.1. NICK Setting</h3></div></div></div><p>This setting allows you to change the Nickname that ModuleName uses when it connects to your network. If you change this setting make sure you update your NeoNet account, otherwise you might loose access to the Secure IRC-Chat site if we perform a check on your network and can't find "ModuleName" running.</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This option requires you to reload ModuleName or restart NeoStats to take effect.</p></div><pre class="screen">/msg ModuleName set NICK <nickname></pre></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e166"></a>3.2. ALTNICK Setting</h3></div></div></div><p>This setting allows you to set a "Backup" nickname used for ModuleName. If the primary Nickname in the NICK Setting is not available, ModuleName will use this nickname, and if that is not available, it will use a automatically generated nickname</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This option requires you to reload ModuleName or restart NeoStats to take effect</p></div><pre class="screen">/msg ModuleName set ALTNICK <nickna
|
||
|
|
</pre><p>command is optional and only required if you want more specific information about a particular command</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e272"></a>4.2. VERSION Command</h3></div></div></div><p>This command displays the Version of ModuleName, and the dat files. </p><p>The format of the command is as follows:</p><pre class="screen">/msg ModuleName version
|
||
|
|
</pre></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e281"></a>4.3. ABOUT Command</h3></div></div></div><p>The about command shows a brief description of the Bot and its purpose.</p><p>The format of the command is as follows:</p><pre class="screen">/msg ModuleName about
|
||
|
|
</pre></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e290"></a>4.4. CREDITS Command</h3></div></div></div><p>The credits command shows details about the authors or contributors of to the Module</p><p>The format of the command is as follows:</p><pre class="screen">/msg ModuleName credits
|
||
|
|
</pre></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e299"></a>4.5. LEVELS Command</h3></div></div></div><p>The levels command allows you to adjust the security of each command available in this module. You can make certian commands only available to higher "level" users in NeoStats. </p><p>For more information about NeoStats Levels and Security, please consult the NeoStats Manual</p><p>To list the currently configured levels, issue the following command:</p><pre class="screen">/msg ModuleName levels list
|
||
|
|
</pre><p>To change the minimum level required to execute a command, issue the following command:</p><pre class="screen">/msg ModuleName levels <command> <level></pre><p>Where:</p><p>command = is the actual command name you wish to modify</p><p>level = a number between 0 and 200 that specifies the new level.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e320"></a>4.6. SET Command</h3></div></div></div><p>The set command allows you to modify settings applicable to this module. For a complete description of the available set options, please consult the Detailed Configuration Section of this manual.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e325"></a>4.7. EXCLUDE Command</h3></div></div></div><p>Exclusion lists allow you to specify certain Hostmasks, Servers, or Channels that should be excluded from monitoring by ModuleName. This exclusion list would allow a administrator to say, allow users on that are matched against Trojans, when the administrator has verified that the Trojan does not in fact exist on the users host.</p><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Caution</h3><p>Exclusions should be setup for your Services Server, so that ModuleName does not try to scan ChanServ, or NickServ, or any of the bots relating to Nickname protection.</p></div><p>With NeoStats 3.0, you should also be aware that there are two types of Exclusion Lists. There are "Global" exclusion lists that all modules may optionally use, and there is module specific exclusion lists. ModuleName defaults to not using the Global Exclusion lists. You can enable it by the following command:</p><pre class="screen">/msg ModuleName set exclusions on</pre><p><span class="bold"><strong>Adding a Entry</strong></span></p><p>To add a entry to the Exclusion list, use the following format:</p><pre class="screen">/msg ModuleName exclude add <host/Server/Channel/UserHost> <pattern> <reason></pre><p>Where:</p><p><Host/Server/Channel/UserHost> = The type of exclusion you are adding. The different types are:</p><div class="itemizedlist"><ul type="disc"><li><p>Host - The Users real (Internet) Hostname</p></li><li><p>Server - The Users server they are connecting to. You should ensure you add a exclusion for your Services Server</p></li><li><p>Channel - A specific channel on your IRC Network</p></li><li><p>UserHost - The users Virtual Hostname (IRC)</p></li></ul></div><p><pattern> = The pattern you wish to match on. May include wildcard charactors such as * and ?</p><p><reason> = a short description of the exclusion, for operator reference only.</p><p>The output is as follows:</p><pre class="screen">[13:20] -ModuleName- Added *.blah.com (userhost) to exclusion list
|
||
|
|
[13:20] ModuleName Fish added *.blah.com (userhost) to the exclusion list</pre><p><span class="bold"><strong>Listing an Entry</strong></span></p><p>To list the Exclusions simple type:</p><pre class="screen">/msg ModuleName exclude list</pre><p>And all the current exclusions are listed. Additionally, a Position number is provided for use with the delete command. The output is as follows:</p><pre class="screen">[13:21] -ModuleName- Exclusion list:
|
||
|
|
[13:21] -ModuleName- #bothouse (Channel) Added by Fish on Sat Aug 13 2005 01:20 AM SGT for Requested
|
||
|
|
[13:21] -ModuleName- #ircop (Channel) Added by Fish on Sat Aug 13 2005 07:40 PM SGT for IRCop channel
|
||
|
|
[13:21] -ModuleName- *irc-chat.net (Host) Added by Fish on Tue Aug 09 2005 10:13 PM SGT for Services Exclusion
|
||
|
|
[13:21] -ModuleName- chieftess!*@* (Userhost) Added by Fish on Tue Aug 09 2005 10:14 PM SGT for buggy client
|
||
|
|
[13:21] -ModuleName- *.blah.com (Userhost) Added by Fish on Sun Jan 15 2006 01:20 PM SGT for Cause Blah.com is cool
|
||
|
|
[13:21] -ModuleName- End of list.</pre><p><span class="bold"><strong>Deleting an Entry</strong></span></p><p>To delete a entry, you should first lookup the Position of the entry that you wish to delete. The format of the command is as follows:</p><pre class="screen">/msg ModuleName exclude del <pattern></pre><p>Where:</p><p><pattern> is the pattern of the entry you wish to delete in the list</p><p>The output of the command is as follows:</p><pre class="screen">[13:22] ModuleName Fish used EXCLUDE
|
||
|
|
[13:22] -ModuleName- *.blah.com delete from exclusion list</pre></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e395"></a>4.8. BLAHBLAH Command</h3></div></div></div><p>That command forces ModuleName to check the Dat File version at <a href="#">http://secure.irc-chat.net/</a> and download the latest version if required.</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Repeated use of this command in a short period of time will result in your account at secure.irc-chat.net being suspended for abuse. Use with CARE</p></div><p>The format of the command is as follows:</p><pre class="screen">/msg ModuleName update</pre></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e410"></a>5. Optional Chapter</h2></div></div></div><p>use this to write any optional information etc etc etc</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e415"></a>5.1. Optional Sub Heading</h3></div></div></div><p>Subheading</p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e420"></a>5.1.1. Minor heading</h4></div></div></div><p>minor heading</p></div></div></div></div></body></html>
|