************************************************************************ ** NeoStats - IRC Statistical Services ** ** Copyright (c) 1999-2008 NeoStats Group. All Rights Reserved. ** ** This program and all associated documentation is free but ** ** copyrighted software; see the file COPYING for details. ** ** Homepage: http://www.neostats.net/ ** ************************************************************************ User Manual ----------- This document explains how to use NeoStats and the commands available for the various components. If you are looking for help configuring or installing NeoStats or for support information please refer to the README file. For help on downloaded modules, refer to the documentation that comes with the module. Typically, after installation, the documentation for the downloaded module is named "README." Most NeoStats components include online help so you can find out how to use a command while on IRC. To access general online help use: /msg BotName HELP To access online help for a given command use: /msg BotName HELP COMMAND -----------------------------------<>----------------------------------- Contents -------- 1. Introduction 2. NeoStats 2.1 About NeoStats 2.2 Available Commands 2.3 Command Reference 2.3.1 HELP 2.3.2 STATUS 2.3.3 VERSION 2.3.4 LEVEL 2.3.5 SHUTDOWN 2.3.6 RELOAD 2.3.7 LOAD 2.3.8 UNLOAD 2.3.9 MODLIST 2.3.10 LOGS 2.3.11 RAW 2.3.12 JUPE 2.3.13 DEBUG 2.3.14 USERDUMP 2.3.15 SERVERDUMP 2.3.16 CHANDUMP 2.3.17 BOTLIST 2.3.18 SOCKLIST 2.3.19 TIMERLIST 3. StatServ 3.1 About StatServ 3.2 Available Commands 3.3 Command Reference 3.3.1 SERVER 3.3.2 MAP 3.3.3 CHAN 3.3.4 NETSTATS 3.3.5 DAILY 3.3.6 TLD 3.3.7 TLDMAP 3.3.8 OPERLIST 3.3.9 BOTLIST 3.3.10 CLIENTVERSIONS 3.3.11 VERSION 3.3.12 SET 3.3.13 FORCEUPDATE 3.3.14 STATS 3.4 HTML Syntax 4. ConnectServ 4.1 About ConnectServ 4.2 Available Commands 4.3 Command Reference 4.3.1 HELP 4.3.2 ABOUT 4.3.3 VERSION 4.3.4 SET 5. HostServ 5.1 About HostServ 5.2 Available Commands 5.3 Command Reference 5.3.1 HELP 5.3.2 ABOUT 5.3.3 VERSION 5.3.4 SET 5.3.5 ADD 5.3.6 DEL 5.3.7 VIEW 5.3.8 LIST 5.3.9 LOGIN 5.3.10 CHPASS 5.3.11 BANS 6. LoveServ 6.1 About LoveServ 6.2 Available Commands 6.3 Command Reference 6.3.1 HELP 6.3.2 VERSION 6.3.4 ROSE 6.3.5 KISS 6.3.6 TONSIL 6.3.7 HUG 6.3.8 ADMIRER 6.3.9 CHOCOLATE 6.3.10 CANDY 6.3.11 LOVENOTE 6.3.12 APOLOGY 6.3.13 THANKYOU 7. MoraleServ 7.1 About MoraleServ 7.2 Available Commands 7.3 Command Reference 7.3.1 HELP 7.3.2 VERSION 7.3.3 CREDITS 7.3.4 HAIL 7.3.5 ODE 7.3.6 POEM 7.3.7 LAPDANCE 7.3.8 REDNECK 7.3.9 CHEERUP 7.3.10 BEHAPPY 7.3.11 WONDERFUL 8. ExtAuth 8.1 About ExtAuth -----------------------------------<>----------------------------------- 1. Introduction --------------- To send a command to a NeoStats module or bot you will always use the following from an IRC Client: /msg botname command [options] e.g. /msg NeoStats MAP If you change the default name of a bot, you will need to change the command. If you decided to change the name of StatServ to StatBot, then you must use this name when entering commands: e.g. /msg StatBot MAP Commands are listed here in upper case to make reading this document easier. IRC is not case sensitive. This means that: /msg StatServ MAP /msg StatServ map /msg statserv Map will all perform the same task. Some commands of NeoStats and StatServ are available to all users as well as opers unless you specify ONLY_OPERS in neostats.cfg. Refer to README and neostats.cfg for more information on the ONLY_OPERS option. Command help in this document is broken into three sections: Syntax: The syntax used for a command Description: Description of the command and it's options Example: Example of how to use the command Optional parameters are presented between [] e.g. [reason] Required parameters are presented between <> e.g. The | character indicates that only one of the option list can be used at any one time. e.g. option1|option2 When using the command, do not use the [],<> or | from the syntax. -----------------------------------<>----------------------------------- 2. NeoStats ----------- 2.1 About NeoStats ------------------ NeoStats is the core component of NeoStats Services. It manages booting of the system, loading and unloading of modules and assignment of privilege levels to users. 2.2 Available Commands ---------------------- HELP Display help STATUS Stats Info on NeoStats and uptime. VERSION Display the current NeoStats Version. LEVEL Display Permission Level for NeoStats. SHUTDOWN Shutdown NeoStats. RELOAD Force NeoStats to Reload Itself. LOAD Load a Module. UNLOAD Unload a Module. MODLIST List Loaded Modules. LOGS View logfiles. RAW Send a Raw Command from this Server! JUPE Jupiter a Server JOIN Tell NeoStats to join a channel DEBUG Enable/Disable debugging USERDUMP Dump User info for debug SERVERDUMP Dump Server info for debug CHANDUMP Dump Channel info for debug BOTLIST List of current bots SOCKLIST List of current sockets TIMERLIST List of current timers BOTCHANLIST List of current bot channels 2.3 Command Reference --------------------- 2.3.1 HELP ---------- Syntax: /msg NeoStats HELP [command] Description: HELP displays available commands. HELP COMMAND will display help for that command. Available to users if ONLY_OPERS not set Example: /msg NeoStats HELP /msg NeoStats HELP STATUS 2.3.2 VERSION ------------- Syntax: /msg xxxxxxxx VERSION Description: Shows the current xxxxxxxx Version. Example: /msg xxxxxxxx VERSION 2.3.3 CREDITS ------------- Syntax: /msg xxxxxxxx CREDITS Description: Display copyright and credits for xxxxxxxx. Example: /msg xxxxxxxx CREDITS 2.3.4 SET --------- Syntax: /msg xxxxxxxx SET LIST /msg xxxxxxxx SET