tidy up doco etc in preperation for 3.0.0

This commit is contained in:
Fish 2008-03-05 04:12:56 +00:00
parent 6a2b8ea90b
commit 1e817aaf3c
28 changed files with 152 additions and 743 deletions

17
.gitattributes vendored
View file

@ -6,7 +6,6 @@
/CREDITS -text
/ChangeLog -text
/ChangeLog.old -text
/Config -text
/INSTALL -text
/INSTNOTES -text
/INSTNOTES.svn -text
@ -45,12 +44,8 @@ autotools/ylwrap -text
/configure.in -text
data/niconfig.db -text
data/tlds.nfo -text
doc/FAQ -text
doc/CODINGMODULES.txt -text
doc/README.dev -text
doc/README.french -text
doc/USERMAN -text
doc/USERMAN.html -text
doc/USERMAN.xml -text
doc/old/ChangeLog.connectserv.old -text
doc/old/ChangeLog.hostserv.old -text
doc/old/ChangeLog.loveserv.old -text
@ -58,11 +53,16 @@ doc/old/ChangeLog.moraleserv.old -text
doc/old/ChangeLog.neoserv.old -text
doc/old/ChangeLog.operlog.old -text
doc/old/ChangeLog.statserv.old -text
doc/old/FAQ -text
doc/old/FAQ.pt -text
doc/old/INSTALL.pt -text
doc/old/README.french -text
doc/old/README.pt -text
doc/read-faq -text
doc/read-userman -text
doc/old/USERMAN -text
doc/old/USERMAN.html -text
doc/old/USERMAN.xml -text
doc/old/read-faq -text
doc/old/read-userman -text
doc/test.pl -text
doc/test2.pl -text
graveyard/include/rtaserv.h -text
@ -429,7 +429,6 @@ modules/limitserv/help.c -text
modules/limitserv/limitserv.h -text
modules/limitserv/limitserv.vcproj -text
modules/limitserv/main.c -text
modules/modules.txt -text
modules/nstest/Makefile.am -text
modules/nstest/commands.c -text
modules/nstest/commands.h -text

10
AUTHORS
View file

@ -2,7 +2,7 @@ The guys that have no social life, in order to give you NeoStats are:
(speak for yerself fish :P~)
Justin Hammond, AKA Fish - fish@dynam.ac
Justin Hammond, AKA Fish - justin at dynam dot ac
----------------------------------------
Location: Singapore
Currently:
@ -10,7 +10,7 @@ Currently:
Found on:
irc.irc-chat.net #NeoStats
Mark Hetherington, AKA M - m@neostats.net
Mark Hetherington, AKA M - m at neostats dot net
-----------------------------------------
Location: UK
Currently:
@ -18,7 +18,7 @@ Currently:
Found on:
irc.ctcp.net #opers
DeadNotBuried, - dnb@neostats.net
DeadNotBuried, - dnb at neostats dot net
---------------------------------
Location: Australia
Currently:
@ -28,7 +28,7 @@ Found on:
Previous Developers:
Adam Rutter, AKA Shmad - shmad@neostats.net
Adam Rutter, AKA Shmad - shmad at neostats dot net
-------------------------------------------
Location: Canada
Previously:
@ -38,7 +38,7 @@ Previously:
Found on:
????
Unknown, AKA ^Enigma^ - enigma@neostats.net
Unknown, AKA ^Enigma^ - enigma at neostats dot net
-------------------------------------------
Location: Australia
Currently:

2
BUGS
View file

@ -1,5 +1,5 @@
For a list of known bugs and progress reports please use our bug
tracking system at:
http://bugs.neostats.net/index.php
http://bugs.neostats.net/jira/

View file

@ -5,7 +5,8 @@ development of NeoStats in their own various ways over the years and who have
helped better this project for all users. Thanks to everyone :)
chrisv@b0rked.dhs.org Code for Dynamically Loading Modules (Hurricane IRCD)
chrisv at b0rked dot dhs net org
Code for Dynamically Loading Modules (Hurricane IRCD)
monkeyIRCD Module Segv Catching code
@ -38,5 +39,5 @@ herrohr liquid IRCd support
Shmad Previous Developer of NeoStats from version 1.0 till the 2.0 series
If we left anyone out of this list please email support@neostats.net and if you
do deserve to be on this list you shall be added.
If we left anyone out of this list please email admin @ lists dot neostats
dot net and if you do deserve to be on this list you shall be added.

396
Config
View file

@ -1,396 +0,0 @@
#!/bin/sh
###########################################################################
#IRCD vars
IRCD_DEFAULT="no default"
IRCD=
#module vars
MODULELIST=""
MSTATSERV=1
MLOVESERV=1
MHOSTSERV=1
MMORALESERV=1
MCONNECTSERV=1
MIRCDAUTH=1
MEXTAUTH=0
MEXTAUTHALLOWED=1
MEXTAUTHSTRING=""
MIRCDAUTHSTRING=""
HAVEMOD=0
HAVEMODS=0
###########################################################################
echo_no_lf ()
{
$ECHO_NO_LF "$*$ECHO_NO_LF_SUFFIX" # these are defined later
}
ECHO_NO_LF_SUFFIX=''
if [ "`echo -n a ; echo -n b`" = "ab" ] ; then
ECHO_NO_LF='echo -n'
elif [ "`echo 'a\c' ; echo 'b\c'`" = "ab" ] ; then
ECHO_NO_LF='echo' ; ECHO_NO_LF_SUFFIX='\c'
elif [ "`printf 'a' 2>&1 ; printf 'b' 2>&1`" = "ab" ] ; then
ECHO_NO_LF='printf "%s"'
else
# oh well...
ECHO_NO_LF='echo'
fi
export ECHO_NO_LF ECHO_NO_LF_SUFFIX
###########################################################################
# select IRCd
validselection=0
echo "Which IRC server do you use?"
echo " 1) Unreal 3.1.x IRCD"
echo " 2) Unreal 3.2.x IRCD"
echo " 3) Ultimate 2.x.x IRCD"
echo " 4) Ultimate 3.x.x IRCD"
echo " 5) Hybrid7 IRCD"
echo " 6) NeoIRCd IRCD"
echo " 7) Bahamut IRCD"
echo " 8) Mystic IRCD"
echo " 9) Quantum IRCD"
echo " 10) Viagra IRCD"
echo " 11) IRCu P10 (Experimental)"
while [ $validselection -eq 0 ] ; do
echo_no_lf "[$IRCD_DEFAULT] "
if read INPUT ; then : ; else echo "" ; exit 1 ; fi
if [ ! "$INPUT" ] ; then
INPUT=$IRCD_DEFAULT
fi
case $INPUT in
no\ default)
echo "You must specify your IRC server type in order for NeoStats to function"
echo "correctly."
;;
1)
IRCD="--enable-unreal31"
validselection=1
;;
2)
IRCD="--enable-unreal32"
validselection=1
;;
3)
IRCD="--enable-ultimate2"
validselection=1
;;
4)
IRCD="--enable-ultimate3"
validselection=1
;;
5)
IRCD="--enable-hybrid7"
MEXTAUTHALLOWED=0
validselection=1
;;
6)
IRCD="--enable-neoircd"
validselection=1
;;
7)
IRCD="--enable-bahamut"
validselection=1
;;
8)
IRCD="--enable-mystic"
validselection=1
;;
9)
IRCD="--enable-quantum"
validselection=1
;;
10)
IRCD="--enable-viagra"
validselection=1
;;
11)
IRCD="--enable-ircup10"
validselection=1
;;
*)
echo "Please enter a valid option number."
;;
esac
done
IRCD_DEFAULT=$INPUT
echo ""
####
###########################################################################
#module selection
validselection=0
if [ "$MSTATSERV" = 1 ] ; then
YN_DEFAULT=yes
else
YN_DEFAULT=no
fi
echo "Do you want to build StatServ?"
while [ $validselection -eq 0 ] ; do
echo_no_lf "[$YN_DEFAULT] "
if read INPUT ; then : ; else echo "" ; exit 1 ; fi
if [ ! "$INPUT" ] ; then
INPUT=$YN_DEFAULT
fi
case $INPUT in
n*|N*)
MSTATSERV=0
validselection=1
;;
y*|Y*)
MSTATSERV=1
HAVEMODS=1
validselection=1
;;
*)
echo 'Please enter "yes" or "no".'
;;
esac
done
echo ""
if [ "$MLOVESERV" = 1 ] ; then
YN_DEFAULT=yes
else
YN_DEFAULT=no
fi
validselection=0
echo "Do you want to build LoveServ?"
while [ $validselection -eq 0 ] ; do
echo_no_lf "[$YN_DEFAULT] "
if read INPUT ; then : ; else echo "" ; exit 1 ; fi
if [ ! "$INPUT" ] ; then
INPUT=$YN_DEFAULT
fi
case $INPUT in
n*|N*)
MLOVESERV=0
validselection=1
;;
y*|Y*)
MLOVESERV=1
HAVEMODS=1
validselection=1
;;
*)
echo 'Please enter "yes" or "no".'
;;
esac
done
echo ""
if [ "$MHOSTSERV" = 1 ] ; then
YN_DEFAULT=yes
else
YN_DEFAULT=no
fi
validselection=0
echo "Do you want to build HostServ?"
while [ $validselection -eq 0 ] ; do
echo_no_lf "[$YN_DEFAULT] "
if read INPUT ; then : ; else echo "" ; exit 1 ; fi
if [ ! "$INPUT" ] ; then
INPUT=$YN_DEFAULT
fi
case $INPUT in
n*|N*)
MHOSTSERV=0
validselection=1
;;
y*|Y*)
MHOSTSERV=1
HAVEMODS=1
validselection=1
;;
*)
echo 'Please enter "yes" or "no".'
;;
esac
done
echo ""
if [ "$MMORALESERV" = 1 ] ; then
YN_DEFAULT=yes
else
YN_DEFAULT=no
fi
validselection=0
echo "Do you want to build MoraleServ?"
while [ $validselection -eq 0 ] ; do
echo_no_lf "[$YN_DEFAULT] "
if read INPUT ; then : ; else echo "" ; exit 1 ; fi
if [ ! "$INPUT" ] ; then
INPUT=$YN_DEFAULT
fi
case $INPUT in
n*|N*)
MMORALESERV=0
validselection=1
;;
y*|Y*)
MMORALESERV=1
HAVEMODS=1
validselection=1
;;
*)
echo 'Please enter "yes" or "no".'
;;
esac
done
echo ""
if [ "$MIRCDAUTH" = 1 ] ; then
YN_DEFAULT=yes
else
YN_DEFAULT=no
fi
if [ "$MCONNECTSERV" = 1 ] ; then
YN_DEFAULT=yes
else
YN_DEFAULT=no
fi
validselection=0
echo "Do you want to build ConnectServ?"
while [ $validselection -eq 0 ] ; do
echo_no_lf "[$YN_DEFAULT] "
if read INPUT ; then : ; else echo "" ; exit 1 ; fi
if [ ! "$INPUT" ] ; then
INPUT=$YN_DEFAULT
fi
case $INPUT in
n*|N*)
MCONNECTSERV=0
validselection=1
;;
y*|Y*)
MCONNECTSERV=1
HAVEMODS=1
validselection=1
;;
*)
echo 'Please enter "yes" or "no".'
;;
esac
done
echo ""
###########################################################################
validselection=0
echo "Do you want to enable IRCD user mode authentication?"
while [ $validselection -eq 0 ] ; do
echo_no_lf "[$YN_DEFAULT] "
if read INPUT ; then : ; else echo "" ; exit 1 ; fi
if [ ! "$INPUT" ] ; then
INPUT=$YN_DEFAULT
fi
case $INPUT in
n*|N*)
MIRCDAUTH=0
validselection=1
;;
y*|Y*)
MIRCDAUTH=1
MIRCDAUTHSTRING="--enable-ircdauth"
HAVEMODS=1
validselection=1
;;
*)
echo 'Please enter "yes" or "no".'
;;
esac
done
echo ""
###########################################################################
# ExtAuth (do not ask for hybrid or any ircd which auto sets it)
if [ "$MEXTAUTHALLOWED" = 1 ] ; then
if [ "$MEXTAUTH" = 1 ] ; then
YN_DEFAULT=yes
else
YN_DEFAULT=no
fi
validselection=0
echo "Do you want to enable nick!user@host mask authentication?"
while [ $validselection -eq 0 ] ; do
echo_no_lf "[$YN_DEFAULT] "
if read INPUT ; then : ; else echo "" ; exit 1 ; fi
if [ ! "$INPUT" ] ; then
INPUT=$YN_DEFAULT
fi
case $INPUT in
n*|N*)
MEXTAUTH=0
validselection=1
;;
y*|Y*)
MEXTAUTH=1
MEXTAUTHSTRING="--enable-extauth"
validselection=1
;;
*)
echo 'Please enter "yes" or "no".'
;;
esac
done
echo ""
fi
if [ "$HAVEMODS" = 1 ] ; then
if [ "$MSTATSERV" = 1 ] ; then
if [ "$HAVEMOD" = 1 ] ; then
MODULELIST="$MODULELIST "
fi
HAVEMOD=1
MODULELIST=$MODULELIST"statserv"
fi
if [ "$MLOVESERV" = 1 ] ; then
if [ "$HAVEMOD" = 1 ] ; then
MODULELIST="$MODULELIST "
fi
HAVEMOD=1
MODULELIST=$MODULELIST"loveserv"
fi
if [ "$MHOSTSERV" = 1 ] ; then
if [ "$HAVEMOD" = 1 ] ; then
MODULELIST="$MODULELIST "
fi
HAVEMOD=1
MODULELIST=$MODULELIST"hostserv"
fi
if [ "$MMORALESERV" = 1 ] ; then
if [ "$HAVEMOD" = 1 ] ; then
MODULELIST="$MODULELIST "
fi
HAVEMOD=1
MODULELIST=$MODULELIST"moraleserv"
fi
if [ "$MCONNECTSERV" = 1 ] ; then
if [ "$HAVEMOD" = 1 ] ; then
MODULELIST="$MODULELIST "
fi
HAVEMOD=1
MODULELIST=$MODULELIST"connectserv"
fi
fi
###########################################################################
#print ./configure line
#echo ./configure $IRCD $MEXTAUTHSTRING $MIRCDAUTHSTRING --enable-modules="$MODULELIST"
./configure $IRCD $MEXTAUTHSTRING $MIRCDAUTHSTRING --enable-modules="$MODULELIST"
###########################################################################

231
INSTALL
View file

@ -1,229 +1,2 @@
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
==================
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. (Caching is
disabled by default to prevent problems with accidental use of stale
cache files.)
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'. You only need
`configure.ac' if you want to change it or regenerate `configure' using
a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the `configure' script does not know about. Run `./configure --help'
for details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not support the `VPATH'
variable, you have to compile the package for one architecture at a
time in the source code directory. After you have installed the
package for one architecture, use `make distclean' before reconfiguring
for another architecture.
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out
automatically, but needs to determine by the type of machine the package
will run on. Usually, assuming the package is built to be run on the
_same_ architectures, `configure' can figure that out, but if it prints
a message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the `--target=TYPE' option to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
will cause the specified gcc to be used as the C compiler (unless it is
overridden in the site shell script).
`configure' Invocation
======================
`configure' recognizes the following options to control how it
operates.
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
See the README file or for up to date installation instructions, visit
http://wiki.neostats.net/confluence/display/NeoStats/Installation

View file

@ -1,18 +1,18 @@
__________________________________________________
| NeoStats compiled and installed successfully. |
| |
| Please read the README and the documentation in |
| the doc directory for information on how to |
| configure NeoStats. |
| |
| You should now build and install any external |
| modules such as SecureServ, OPSB, LogServ, |
| StupidServ or any third party modules. Refer to |
| the documentation with the modules for details |
| on how to compile and install it. |
| |
| If this is an upgrade, you still need to rebuild |
| and install external modules before running this |
| version of NeoStats |
|__________________________________________________|
_______________________________________________________
| NeoStats compiled and installed successfully. |
| |
| Please read the README and visit |
| http://wiki.neostats.net/confluence/display/NeoStats/ |
| for information on how to configure NeoStats. |
| |
| You should now build and install any external modules |
| such as SecureServ, OPSB, LogServ, StupidServ or any |
| third party modules. Refer to the documentation with |
| the modules for details on how to compile and install |
| it. |
| |
| If this is an upgrade, you still need to rebuild and |
| install external modules before running this version |
| of NeoStats |
|_______________________________________________________|

View file

@ -1,11 +1,11 @@
__________________________________________________
| NeoStats Development Version |
| |
| ******** WARNING ******** |
| |
| You are running the development version of |
| NeoStats. No support is provided for development |
| versions. Please read doc/README.dev before |
| running this version on your network. |
|__________________________________________________|
_______________________________________________________
| NeoStats Development Version |
| |
| ******** WARNING ******** |
| |
| You are running the development version of NeoStats. |
| No support is provided for development versions. |
| Please read doc/README.dev before running this version|
| on your network. |
|_______________________________________________________|

View file

@ -6,7 +6,7 @@ DISTCHECK_CONFIGURE_FLAGS = --cache-file=../config.cache
dist_bin_SCRIPTS = makeconf
dist_data_DATA = neostats.motd
#docdir = @prefix@/doc
dist_doc_DATA = doc/FAQ doc/USERMAN
dist_doc_DATA = doc/README.dev Changelog.old doc/CODINGMODULES.txt
neodir = $(prefix)
neo_SCRIPTS = neostats
DISTCLEANFILES = autotools/ccdv

View file

@ -43,7 +43,7 @@ DIST_COMMON = README $(am__configure_deps) $(dist_bin_SCRIPTS) \
AUTHORS COPYING ChangeLog INSTALL NEWS TODO autotools/compile \
autotools/config.guess autotools/config.sub autotools/depcomp \
autotools/install-sh autotools/ltmain.sh autotools/missing \
autotools/mkinstalldirs
autotools/mkinstalldirs autotools/ylwrap
subdir = .
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/autotools/acinclude.m4 \
@ -248,7 +248,7 @@ DISTCHECK_CONFIGURE_FLAGS = --cache-file=../config.cache
dist_bin_SCRIPTS = makeconf
dist_data_DATA = neostats.motd
#docdir = @prefix@/doc
dist_doc_DATA = doc/FAQ doc/USERMAN
dist_doc_DATA = doc/README.dev Changelog.old
neodir = $(prefix)
neo_SCRIPTS = neostats
DISTCLEANFILES = autotools/ccdv

66
README
View file

@ -38,13 +38,17 @@ but a brief summary is:
session.
- Native Windows support including full support for modules.
- All commands have configurable user levels.
- Perl API, so you can write new modules or extend existing modules
in the Perl Scripting Language
- Automatic notification of new versions, when they become available
- a large range of supported IRCd's
Visit http://www.neostats.net for the latest news and NeoStats updates.
Please read all documentation included with NeoStats carefully. The
documents contain all the information you need to get NeoStats running
on your network. These documents include README, and all the documents
in the doc directory.
on your network. These documents include README, and the wiki, at
http://wiki.neostats.net/confluence/display/NeoStats/Home
-----------------------------------<>-----------------------------------
All documentation applies to version 3.0.0 and higher. For older
@ -57,16 +61,17 @@ Following is a quick guide to the main NeoStats documentation:
README - This file. How to install and configure NeoStats
and support information.
DOCS/USERMAN - Manual for run time operation of NeoStats. You should
read this when you have NeoStats running for information
on how to use NeoStats.
DOCS/FAQ - Frequently Asked Questions about NeoStats.
RELNOTES - Release notes about the current version. This is
displayed during the installation process but you should
refer to it if you have problems.
ChangeLog - Information about what has changed between versions.
Consult this document for detailed information about the
changes.
The Majority of Documentation can now be found on our NeoStats Wiki,
located at http://wiki.neostats.net/confluence/display/NeoStats/Home
You are encouraged to check that site, as thats where most recent
version of our documenation will be
-----------------------------------<>-----------------------------------
Contents
@ -267,12 +272,13 @@ change to the directory where NeoStats in installed e.g.
Then to run NeoStats type:
./neostats
./neostats start
It should link and sync with your server in a matter of seconds.
Please now read USERMAN for details on how to operate NeoStats from an
IRC Client.
Please now read
http://wiki.neostats.net/confluence/display/NeoStats/Operator+Manual
for details on how to operate NeoStats from an IRC Client.
If anything goes wrong, there *might* be an error message in the log
files. Have a look in ~/NeoStats3.0/logs/neostats-date.log it might give
@ -292,7 +298,7 @@ useful:
To use these options, add the option(s) you require when you run
NeoStats, e.g.:
./bin/neostats -h
./neostats start -h
Note: although you can combine most of these options, -v (version)
and -h (help) will return information to you and NeoStats will not
@ -430,14 +436,15 @@ find out when they are fixed. For the bug tracking system, visit:
http://www.neostats.net/boards/
* The Neostats Wiki available at:
http://wiki.neostats.net/confluence/display/NeoStats/
* The NeoStats IRC support channel at:
server: irc.irc-chat.net
channel: #neostats
Be warned that we are not always available on the channel to help you.
There is a bot there called neoserv that contains the latest bugs and
support information (duplicated from the NeoStats board).
2.2 What to provide when requesting support
-------------------------------------------
@ -470,6 +477,22 @@ files:
This will help us to be able to reproduce the bug and create a fix for
it.
Sometimes we might request you to run a GDB backtrace of the problem
In order to generate that you will execute the following commands:
gdb bin/neostats
when you arrive at the GDB command prompt, type:
run -fd 10
now go and make NeoStats crash in some way. when it crashs, you will
be returned to the GDB command prompt. Type:
bt full
and save that output to send to us. To exit GDB, just type "quit"
Remember you cannot give us too much information about your system and
setup, but if you do not give us enough, we cannot help you and if we
have to keep asking you to provide more information, that is less time
@ -485,18 +508,27 @@ Want to Help us?
We are always looking for help.
Currently, what we really are looking for is people to help us out with
translating our documentation and of course, other people that can code
our documentation on the wiki and of course, other people that can code
in C to help us with development.
We hope to shortly provide a Module Programmers Guide to help those
people out there take advantage of NeoStats and write their own
extensions (or Modules) for NeoStats.
if you would like to have a go at writting your own module, in either
C or Perl, you can consult
http://wiki.neostats.net/confluence/display/Dev for documenation. We
will also provide you with a SVN repository, bug tracker, and all the
other tools that we use (such as build servers etc) if you want it.
Just contact Fish to find out how to get started.
If you would like to help out, See Support Information above for details
on how to contact us.
Finally, as I (Fish) do not have a single artistic bone in my body, I'm
always looking for people to help out with our websites at
http://www.neostats.net and http://secure.irc-chat.net/. If you are any
good with HTML and would like to help us "spruce" up our webpages, just
contact me.
-----------------------------------<>-----------------------------------
************************************************************************
** This document was last updated on January 31st, 2005 by M **
** This document was last updated on March 5th, 2008 by Fish **
************************************************************************

View file

@ -1,13 +1,29 @@
Win32 Build files
NeoStats for Windows requires Microsoft Visual Studio .NET 2003.
NeoStats for Windows requires Microsoft Visual Studio .NET 2005.
It may or not build on other versions of Visual Studio.
Main build files:
neostatslibs.sln - Library solution.
neostats.sln - Main solution.
NeoStats requires that ActivePerl be installed before you compile,
and that the ActivePerl installation is located at c:\perl. If your
activeperl is located at a different location, you will have to
modify the INCLUDE and LIBRARY paths specifiec in the properties
of the neostats.sln solution.
NeoStats depends on the libraries in the library solution. To build
NeoStats for Windows, load the library solution and select build
solution from the Build menu. Then load the neostats solution and
select build solution from the Build menu.
The NeoStats Setup exe that we distribute NeoStats with also
contains the library and header files you need to compile other
modules. By default they are installed when you install NeoStats
and are located in the include and library directories of your
NeoStats installation. 3rd party modules (such as OPSB) are
setup to look in these directories when building, so if you
change the location of NeoStats installation then you will
need to modify the INCLUDE and LIBRARY paths for those
3rd party modules to point to the correct directory.

View file

@ -1,32 +1,21 @@
* NeoStats * M & Fish * Version 3.0.a3
* NeoStats * M & DNB & Fish * Version 3.0.0
==============================================================================
Important information you should know: (READ THIS!)
==============================================================================
This is an alpha release. Not all features will work and there may be major
bugs in the software. This release is purely for us to get feedback on the new
version of NeoStats and should not be run on production networks. This release
is ideal for users with test networks or those that want an opportunity to
help us develop the new version with feedback and suggestions. It also allows
module coders to begin porting their modules to the 3.0 API and making any
requests and suggestions they wish.
No support is provided for this release so if you have problems and are unable
to resolve them using the provided documentation, you should use the supported
stable 2.5 series instead until NeoStats 3.0 is further along.
Bugs, requests and suggestions should be reported using the bug tracking
system. You must provide all information required as listed in the README
section on support or your entry will be removed.
This if the first "gold" release of NeoStats 3.0. It is *NOT* compatible
with previous 2.5.x releases of NeoStats, so you will have to setup
NeoStats all over again. We may, in the future, provide some scripts to
port some of your settings and data from 2.5 to 3.0, but these scripts are
not available now.
NeoStats 3.0 will co exist with an existing 2.5 series installation so you
can run both together for testing this version if you wish.
Settings and data files from 2.5.x will not work with 3.0.
Settings and data files for previous 3.0 alpha versions may not be compatible
with this version. You should delete all files with "gdbm" in the filename
from the directory ~/NeoStats 3.0/data before using this version.
with this version. You should delete or move all files with "gdbm" or "bdb"
in the filename from the directory ~/NeoStats 3.0/data if you have
problems/crashs after upgrading
Known issues that we are aware of and should not be reported:

14
TODO
View file

@ -1,15 +1,3 @@
NeoStats - TODO Log:
--------------------
(have a look at our Bug tracking page for additional TODO's at
http://bugs.neostats.net)
<StatServ> rollergirl.sg.as.irc-chat.net is lagged out with a ping of 1123867742
My NeoStats is using 29Mb of memory on 150 users.... most modules loaded. Valgrind is overdue
just to check memory allocations
http://www.neostats.net/boards/viewtopic.php?t=1672&highlight=
http://www.neostats.net/boards/viewtopic.php?p=7094#7094
http://bugs.neostats.net

View file

@ -6,6 +6,9 @@
** Homepage: http://www.neostats.net/ **
************************************************************************
(For the most recent version of these guides, refer to
http://wiki.neostats.net/confluence/display/Dev)
How to write a NeoStats 3.0 Module
----------------------------------

View file

@ -4,7 +4,8 @@ CLEANFILES = version.h
include_HEADERS = neostats.h config.h version.h \
list.h hash.h support.h events.h numeric.h \
adns.h protocol.h perlmod.h confuse.h\
updates.h MiniMessage.h MiniMessageGateway.h MuscleSupport.h NeoNet.h namedvars.h
updates.h MiniMessage.h MiniMessageGateway.h \
MuscleSupport.h NeoNet.h namedvars.h services.h
noinst_HEADERS = commands.h dns.h servers.h users.h conf.h \

View file

@ -216,7 +216,8 @@ CLEANFILES = version.h
include_HEADERS = neostats.h config.h version.h \
list.h hash.h support.h events.h numeric.h \
adns.h protocol.h perlmod.h confuse.h\
updates.h MiniMessage.h MiniMessageGateway.h MuscleSupport.h NeoNet.h namedvars.h
updates.h MiniMessage.h MiniMessageGateway.h \
MuscleSupport.h NeoNet.h namedvars.h services.h
noinst_HEADERS = commands.h dns.h servers.h users.h conf.h \
log.h services.h modes.h signals.h nsevents.h \

View file

@ -463,6 +463,7 @@ Options {
# NeoStats will default to GDBM if this is not provided.
# Valid options are:
# gdbm
# bdb (if found during configure)
#
# DatabaseType = "gdbm"
#
@ -610,34 +611,36 @@ Modules {
# external modules before trying to load them.
MODULENAME = {
# Update notification module, loaded by default
"update",
# StatServ, maintain and report various networks statistics
# "statserv",
"statserv",
# HostServ, vhost services for users
# "hostserv",
"hostserv",
# TextServ, text messaging service
# "textserv",
"textserv",
# ConnectServ, monitor connections to the network: user connections, oper
# modes, server connections and nick changes.
# "connectserv",
"connectserv",
# Operlog, operator command logging service
# "operlog",
"operlog",
# IRCdauth, authenticate users based on their user modes.
# "ircdauth",
"ircdauth",
# Extauth, authenticate users based on nick!user@host access lists
# "extauth",
"extauth",
# QuoteServ, Quote Message Service
# "quoteserv",
"quoteserv",
# LimitServ, Channel Limit Setting Service
# "limitserv",
"limitserv",
# SecureServ. You must download and install SecureServ first.
# "secureserv",
@ -712,7 +715,7 @@ NeoNet {
# is set to No
# demand - Only connect to NeoNet when there is a pending NeoNet Message
# to be sent.
Connect = "no"
Connect = "yes"
}
###############################################################################

View file

@ -1,5 +1,3 @@
SUBDIRS = dbm protocol @MODULES@
EXTRA_DIST = modules.txt
include $(top_srcdir)/autotools/rules.mk

View file

@ -30,7 +30,7 @@
#include "perlmod.h"
static Bot *perl_bot;
static int perlext_pong (CmdParams *cmds);
static int perlext_pong (const CmdParams *cmds);
const char* perl_copyright[] =
{
@ -108,10 +108,11 @@ XS (XS_NeoStats_Test_PerlExt)
}
}
static void
static int
perl_ext_init() {
newXS("NeoStats::PerlExt::TestPerlExt", XS_NeoStats_Test_PerlExt, __FILE__);
nlog(LOG_INFO, "Loaded Perl Extensions Hooks");
return NS_SUCCESS;
}
@ -250,7 +251,7 @@ int ModFini( void )
}
static int
perlext_pong (CmdParams *cmds) {
perlext_pong (const CmdParams *cmds) {
irc_chanalert(perl_bot, "Got Pong fromm %s", cmds->source->name);
}

View file

@ -121,7 +121,7 @@ ModuleInfo module_info =
/** Bot setting table */
static bot_setting update_settings[] =
{
{"UPDATEURL", &update_cfg.updateurl, SET_TYPE_STRING, 0, BUFSIZE, NS_ULEVEL_ADMIN, NULL, update_help_set_updateurl, update_set_updateurl_cb, ( void *)"http://beta.neostats.net/feed.php" },
{"UPDATEURL", &update_cfg.updateurl, SET_TYPE_STRING, 0, BUFSIZE, NS_ULEVEL_ADMIN, NULL, update_help_set_updateurl, update_set_updateurl_cb, ( void *)"http://www.neostats.net/feed.php" },
{"UPDATEENABLED", &update_cfg.enabled, SET_TYPE_BOOLEAN, 0, 0, NS_ULEVEL_ADMIN, NULL, update_help_set_updateenabled, update_set_updateenabled_cb, ( void* )1 },
NS_SETTING_END()
};