ngircd optimised for use with a tor HS || note to self; compile with ./configure --with-openssl --enable-ipv6
Go to file
Alexander Barton 289a26e9e4 Implement Help() function parsing and returning the help text
This function parses the already read in help text and sends the requested
portions to the user. Parsing is done as following when a user user
issues a "HELP <cmd>" command:

 1. Search the file for a line "- <cmd>",
 2. Output all subsequent lines that start with a TAB (ASCII 9) character
    to the client using NOTICE commands, treat lines containing a single "."
    after the TAB as empty lines.
 3. Break at the first line not starting with a TAB character.

This format allows to have information to each command stored in this file
which will not be sent to an IRC user requesting help which enables us to
have additional annotations stored here which further describe the origin,
implementation details, or limits of the specific command.

A special "Intro" block is returned to the user when the HELP command is
used without a command name.
2013-01-01 14:57:03 +01:00
contrib ngIRCd Release 20 2012-12-17 13:14:32 +01:00
doc Document "HelpFile" in sample-ngircd.conf and ngircd.conf.5 2012-12-31 21:03:23 +01:00
man Document "HelpFile" in sample-ngircd.conf and ngircd.conf.5 2012-12-31 21:03:23 +01:00
src Implement Help() function parsing and returning the help text 2013-01-01 14:57:03 +01:00
.gitignore Rename configure.in to configure.ac 2012-09-24 20:40:31 +02:00
.mailmap Added mailmap file for git-[short]log and git-blame 2010-07-25 15:13:50 +02:00
AUTHORS Update documentation (fix some URL, update some info) 2012-01-14 12:29:53 +01:00
COPYING Update GPL 2 license text to current version 2011-11-06 21:53:15 +01:00
ChangeLog ngIRCd Release 20 2012-12-17 13:14:32 +01:00
INSTALL Allow user mode +x only when "CloakHostModeX" is set 2012-09-26 22:55:10 +02:00
Makefile.am Makefile.am: don't use "make -C", it isn't portable 2012-09-27 01:11:01 +02:00
NEWS ngIRCd Release 20 2012-12-17 13:14:32 +01:00
README Update project description 2012-09-04 13:09:27 +02:00
autogen.sh Rename configure.in to configure.ac 2012-09-24 20:40:31 +02:00
config.guess Updated config.{guess|sub} to version 2012-08-14 2012-09-13 18:32:28 +02:00
config.sub Updated config.{guess|sub} to version 2012-08-14 2012-09-13 18:32:28 +02:00
configure.ng Remove Anope "ngircd" protocol module patches 2012-11-10 21:26:25 +01:00

README

                     ngIRCd - Next Generation IRC Server
                           http://ngircd.barton.de/

               (c)2001-2012 Alexander Barton and Contributors.
               ngIRCd is free software and published under the
                   terms of the GNU General Public License.

                                -- README --


I. Introduction
~~~~~~~~~~~~~~~

ngIRCd is a free, portable and lightweight Internet Relay Chat server for
small or private networks, developed under the GNU General Public License
(GPL; please see the file COPYING for details). It is simple to configure,
can cope with dynamic IP addresses, and supports IPv6 as well as SSL. It is
written from scratch and not based on the original IRCd.

The name ngIRCd means next generation IRC daemon, which is a little bit
exaggerated: lightweight Internet Relay Chat server most probably would be a
better name :-)

Please see the INSTALL document for installation and upgrade information!


II. Status
~~~~~~~~~~~

It is not the goal of ngIRCd to implement all the nasty behaviours of the
original ircd, but to implement most of the useful commands and semantics
specified by the RFCs.

In the meantime ngIRCd should be quite feature complete and stable to be
used in real IRC networks.

Implemented IRC-commands are:

ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, GLINE, HELP, INFO,
INVITE, ISON, JOIN, KICK, KILL, KLINE, LINKS, LIST, LUSERS, MODE, MOTD,
NAMES, NICK, NJOIN, NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT,
REHASH, RESTART, SERVER, SERVICE, SERVLIST, SQUERY, SQUIT, STATS, SUMMON,
TIME, TOPIC, TRACE, USER, USERHOST, USERS, VERSION, WALLOPS, WEBIRC, WHO,
WHOIS, WHOWAS.

III. Features (or: why use ngIRCd?)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- well arranged (lean) configuration file
- simple to build/install, configure and maintain
- supports IPv6 and SSL
- no problems with servers that have dynamic IP addresses
- freely available, modern, portable and tidy C-source
- wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
  IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
- ngIRCd is being actively developed since 2001.


IV. Documentation
~~~~~~~~~~~~~~~~~

More documentation can be found in the "doc/" directory and the homepage of
the ngIRCd: <http://ngircd.barton.de/>.


V. Download
~~~~~~~~~~~

The homepage of the ngIRCd is: <http://ngircd.barton.de/>; you will find
the newest information about the ngIRCd and the most recent ("stable")
releases there.

If you are interested in the latest development versions (which are not
always stable), then please read the section about "GIT" on the homepage and
the file "doc/GIT.txt" which describes the use of GIT, the version control
system used by ngIRCd (homepage: http://git-scm.com/).


VI. Bugs
~~~~~~~~

If you find bugs in the ngIRCd (which might be there :-), please report
them at the following URL:

<http://ngircd.barton.de/bugtracker.php>

There you can read about known bugs and limitations, too.

If you have critics, patches or something else, please feel free to post a
mail to the ngIRCd mailing list: <ngircd-ml@arthur.barton.de> (please see
<http://ngircd.barton.de/support.php#ml> for details) or join the ngIRCd
IRC channel: <irc://irc.barton.de/ngircd>.