- Dokumentation aktualisiert.
[ngircd-alex.git] / doc / en / README
1                      ngIRCd - Next Generation IRC Server
2
3                       (c)2001,2002 by Alexander Barton,
4                     alex@barton.de, http://www.barton.de/
5
6                ngIRCd is free software and published under the
7                    terms of the GNU General Public License.
8
9                                 -- README --
10                            
11                       Ilja Osthoff, <ilja@glide.ath.cx>
12
13
14 I. Introduction
15 ~~~~~~~~~~~~~~~
16
17 ngIRCd is an Open-Source server for the Internet Realy Chat (IRC), which
18 is developped and published under the terms of the GNU General Public
19 Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
20 generation IRC daemon", it's written from scratch and not deduced from the
21 "grandfather of IRC daemons", the daemon of the IRCNet.
22
23
24
25 II. Status
26 ~~~~~~~~~~~
27
28 At present, the ngIRCd is under active development, some features are not
29 implemented, some only partly.
30
31 Till today (more or less complete) implemented IRC-commands:
32
33 ADMIN, AWAY, CHANINFO, CONNECT, DIE, ERROR, INVITE, ISON, JOIN, KICK, KILL,
34 LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN, NOTICE, OPER, PART,
35 PASS, PING, PONG, PRIVMSG, QUIT, RESTART, SERVER, SQUIT, TIME, TOPIC,
36 USERHOST, USER, VERSION, WHO, WHOIS.
37
38
39 III. Features (or: why use ngIRCd?)
40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41
42 - no problems with servers which have dynamic ip-adresses
43 - simple, easy understandable configuration file,
44 - freely published C-Sourcecode,
45 - ngIRCd will be developed on in the future.
46 - supported platforms (tested versions): AIX (3.2.5), A/UX (3.0.1), FreeBSD
47   (4.5), HP-UX (10.20), IRIX (6.5), Linux (2.x), Mac OS X (10.x), NetBSD
48   (1.5.2/i386, 1.5.3/m68k), Solaris (2.5.1, 2.6), and Windows with Cygwin.
49
50
51 IV. Documentation
52 ~~~~~~~~~~~~~~~~~
53
54 English documentation:
55
56 - doc/en/README: the file that you are reading :-)
57 - doc/en/INSTALL: hints for the installation of the ngIRCd
58
59 German documentation:
60
61 - README: readme text in german
62 - INSTALL: german installation instructions
63 - NEWS: what do you think? :-) 
64 - Changelog: the complete history of the ngIRCd
65 - doc/FAQ.txt: frequently asked questions and answers
66 - doc/CVS.txt: hints for the CVS-system
67 - doc/RFC.txt: information about the RFC's
68 - doc/sample-ngircd.conf: sample configuration file
69 - doc/README-AUX.txt: installation hints for A/UX
70 - doc/README-BeOS.txt: the same for BeOS
71
72
73 V. Download
74 ~~~~~~~~~~~
75
76 The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
77 will find the newest information about the ngIRCd and the most recent
78 ("stable") releases there.
79
80 If you are interested in the newest developper-versions (which are not
81 always stable), then please read the section "CVS" on the homepage and
82 the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
83 Versioning System".
84
85
86 VI. Bugs
87 ~~~~~~~~
88
89 If you find bugs in the ngIRCd (which might be there :-), please report
90 them at the following URL:
91
92 <http://arthur.ath.cx/~alex/ngircd/#bugs>
93
94 There you can read about kown bugs, too.
95
96 If you have critics, patches or something else, please feel yourself free
97 to post a mail to: <alex@barton.de> or <alex@arthur.ath.cx>
98
99
100 -- 
101 $Id: README,v 1.7 2002/11/24 18:48:59 alex Exp $