- Dokumentation aktualisiert (u.a. englische Versionen)

README

@@ -9,60 +9,95 @@
 
                            -- README / Liesmich --
                            
+                      Ilja Osthoff, <ilja@glide.ath.cx>
+
+
+ +-----------------------------------------------------------------------+
+ | Please note: English translations of some of the german documentation |
+ | files can be found in the directory "doc/en" -- please have a look!   |
+ +-----------------------------------------------------------------------+
+
 
 I. Einfuehrung
 ~~~~~~~~~~~~~~
 
-ngIRCd ist ein Server fuer den Internet Relay Chat (IRC). Er ist von Grund
+ngIRCd ist ein Open-Source-Server fuer den Internet Relay Chat (IRC), der
-auf neu geschrieben, also nicht wie die meisten anderen IRCd's vom Urvater,
+unter der GNU General Public License (http://www.gnu.org/licenses/gpl.html)
-dem Daemon des IRCNet abgeleitet.
+entwickelt wird. ngIRCd steht fuer "next generation IRC daemon", er ist von
+Grund auf neu geschrieben, also nicht wie die meisten anderen IRCd's vom
+Urvater, dem Daemon des IRCNet abgeleitet.
 
-Zur Zeit befindet sich der ngIRCd noch in Entwicklung, teilweise fehlen noch
-Features oder sind noch nicht "final" implementiert. 
 
-Channels sind inzwischen implementiert (seit Version 0.1.0), privates Chatten
+II. Status
-mit /msg und /query funktioniert ebenso. Server-Links werden dabei unter-
+~~~~~~~~~~~
-stuetzt. Einige User- und Channel-Modes sind implementiert, hier kennt der
+
-Server jedoch noch nicht alles.
+Zur Zeit befindet sich der ngIRCd noch in Entwicklung, manche Features sind
+noch nicht implementiert, andere nur teilweise.
 
 Bisher (mehr oder wenig vollstaendig) implementierte IRC-Befehle:
 
-AWAY, DIE, ERROR, ISON, JOIN, KILL, LINKS, LUSERS, MODE, MOTD, NAMES, NICK,
+AWAY, DIE, ERROR, ISON, JOIN, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES,
-NOTICE, NJOIN, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, RESTART, SERVER,
+NICK, NOTICE, NJOIN, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, RESTART,
-SQUIT, TOPIC, USER, USERHOST, VERSION, WHO, WHOIS.
+SERVER, SQUIT, TOPIC, USER, USERHOST, VERSION, WHO, WHOIS.
-
-Ueber Rueckmeldungen, Bug-Reports und Patches freue ich mich! Also los, haut
-in die Tasten! :-))
-
-Via E-Mail erreichst du mich als <alex@arthur.ath.cx> bzw. <alex@barton.de>.
-Die Homepage des ngIRCd findest du unter <http://arthur.ath.cx/~alex/ngircd/>.
 
 
-Hinweise zur Installation findest du in der Datei INSTALL.
+III. Features (oder: warum gerade ngIRCd?)
-Alle Autoren von ngIRCd sind in AUTHORS aufgefuehrt.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-In der Datei COPYING steht die GNU General Public License.
+
-Das README liest du gerade ,-)
+- keine Probleme mit Servern, deren IP-Adresse dynamisch ist,
+- einfache, uebersichtliche Konfigurationsdatei,
+- frei verfuegbarer C-Quellcode.
+- ngIRCd wird aktiv weiterentwickelt.
+- unterstuetzte Plattformen: A/UX, FreeBSD, Linux, Mac OS X/Darwin und
+  Windows mit Cygwin.
  
 
-II. Vorteile
+IV. Dokumentation
-~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
 
-- keine Probleme mit Servern, deren IP-Adressen nicht statisch sind,
+Im Paket enthalten ist u.a.:
-- uebersichtliche ("schlanke") Konfigurationsdatei,
+
-- frei verfuegbarer, moderner und "aufgeraeumter" C-Quellcode.
+- README: das Dokument, das Du gerade liest :-)
-- ngIRCd wird aktiv weiter entwickelt.
+- INSTALL: Hinweise zur Installation des ngIRCd
+- NEWS: sagt der Name schon :-)
+- ChangeLog: die komplette History des ngIRCd
+- doc/FAQ.txt: haeufige Fragen und Antworten zum ngIRCd
+- doc/CVS.txt: Hinweise zum CVS-System
+- doc/RFC.txt: Infos ueber die RFC's
+- doc/sample-ngircd.conf: Beispiel-Konfigurationsdatei
+- doc/README-AUX.txt: Installationshinweise fuer A/UX
+- doc/README-BeOS.txt: dito fuer BeOS
+
+- doc/en/: englischsprachige Dokumentation
 
 
-III. Unterstuetzte Plattformen
+V. Bezugsquellen
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
 
-- A/UX
+Die Homepage des ngIRCd ist: <http://arthur.ath.cx/~alex/ngircd>; dort
-- FreeBSD
+findest du immer die neusten Informationen ueber den ngIRCd und die aktuellen
-- Linux
+freigegebenen ("stabilen") Releases.
-- Mac OS X
+
-- NetBSD
+Falls du dich fuer die aktuellen Entwicklungs-Versionen (die jedoch nicht
-- Windows mit Cygwin
+immer "stabil" sind) interessierst, dann lese bitte den Punkt "CVS" auf der
+Homepage und die Datei "doc/CVS.txt", die die Verwendung des "Concurrent
+Versioning System" (CVS) beschreibt.
+
+
+VI. Bugs
+~~~~~~~~
+
+Wenn du im ngIRCd Bugs finden solltest (so was soll ja auch vorkommen :-),
+dann lege bitte einen Bug-Report ueber diese URL an:
+
+<http://arthur.ath.cx/~alex/ngircd/#bugs>
+
+Dort kannst du dich auch ueber bekannte Fehler informieren.
+
+Falls du noch Anregungen, Kritik, Patches etc. pp. zum ngIRCd hast, dann
+bitte einfach eine Mail an <alex@barton.de> oder <alex@arthur.ath.cx>
+schreiben.
 
 
 -- 
-$Id: README,v 1.8 2002/03/21 23:25:15 alex Exp $
+$Id: README,v 1.9 2002/05/08 15:43:00 alex Exp $

doc/en/INSTALL

@@ -0,0 +1,17 @@
+
+                     ngIRCd - Next Generation IRC Server
+
+                      (c)2001,2002 by Alexander Barton,
+                    alex@barton.de, http://www.barton.de/
+
+                  ngIRCd ist freie Software und steht unter
+                       der GNU General Public License.
+
+                                -- INSTALL --
+
+                         
+Sorry, the english INSTALL text is not yet available ...
+
+
+-- 
+$Id: INSTALL,v 1.1 2002/05/08 15:43:00 alex Exp $

doc/en/README

@@ -0,0 +1,99 @@
+                     ngIRCd - Next Generation IRC Server
+
+                      (c)2001,2002 by Alexander Barton,
+                    alex@barton.de, http://www.barton.de/
+
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
+
+                                -- README --
+                           
+                      Ilja Osthoff, <ilja@glide.ath.cx>
+
+
+I. Introduction
+~~~~~~~~~~~~~~~
+
+ngIRCd is an Open-Source server for the Internet Realy Chat (IRC), which
+is developped and published under the terms of the GNU General Public
+Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
+generation IRC daemon", it's written from scratch and not deduced from the
+"grandfather of IRC daemons", the daemon of the IRCNet.
+
+
+
+II. Status
+~~~~~~~~~~~
+
+At present, the ngIRCd is under active development, some features are not
+implemented, some only partly.
+
+Till tody (more or less complete) implemented IRC-commands:
+
+AWAY, DIE, ERROR, ISON, JOIN, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES,
+NICK, NOTICE, NJOIN, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, RESTART,
+SERVER, SQUIT, TOPIC, USER, USERHOST, VERSION, WHO, WHOIS.
+
+
+III. Features (or: why use ngIRCd?)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- no problems with servers which have dynamic ip-adresses
+- simple, easy understandable configuration file,
+- freely published C-Sourcecode,
+- ngIRCd will be developed on in the future.
+- supported platforms: A/UX; FreeBSD, Linux, MAC OS X/Darwin and Windows
+  with Cygwin
+
+
+IV. Documentation
+~~~~~~~~~~~~~~~~~
+
+English documentation:
+
+- doc/en/README: the file that you are reading :-)
+- doc/en/INSTALL: hints for the installation of the ngIRCd
+
+German documentation:
+
+- README: readme text in german
+- INSTALL: german installation instructions
+- NEWS: what do you think? :-) 
+- Changelog: the complete history of the ngIRCd
+- doc/FAQ.txt: frequently asked questions and answers
+- doc/CVS.txt: hints for the CVS-system
+- doc/RFC.txt: information about the RFC's
+- doc/sample-ngircd.conf: sample configuration file
+- doc/README-AUX.txt: installation hints for A/UX
+- doc/README-BeOS.txt: the same for BeOS
+
+
+V. Download
+~~~~~~~~~~~
+
+The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
+will find the newest information about the ngIRCd and the most recent
+("stable") releases there.
+
+If you are interested in the newest developper-versions (which are not
+always stable), then please read the section "CVS" on the homepage and
+the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
+Versioning System".
+
+
+VI. Bugs
+~~~~~~~~
+
+If you find bugs in the ngIRCd (which might be there :-), please report
+them at the following URL:
+
+<http://arthur.ath.cx/~alex/ngircd/#bugs>
+
+There you can read about kown bugs, too.
+
+If you have critics, patches or something else, please feel yourself free
+to post a mail to: <alex@barton.de> or <alex@arthur.ath.cx>
+
+
+-- 
+$Id: README,v 1.1 2002/05/08 15:43:00 alex Exp $

doc/sample-ngircd.conf

@@ -1,4 +1,4 @@
-# $Id: sample-ngircd.conf,v 1.8 2002/03/30 13:03:12 alex Exp $
+# $Id: sample-ngircd.conf,v 1.9 2002/05/08 15:43:00 alex Exp $
 
 #
 # Das ist eine Beispiel-Konfiguration fuer den ngIRCd, die an die
@@ -6,6 +6,9 @@
 #
 # Kommentare werden mit "#" oder ";" eingeleitet.
 #
+# Autor: Alexander Barton, <alex@barton.de>
+# Erweiterungen von Ilja Osthoff, <ilja@glide.ath.cx>
+#
 
 [Global]
 
@@ -13,20 +16,23 @@
 	# Im [Global]-Abschnitt der Konfigurationsdatei wird der Server
 	# "an sich" konfiguriert. Notwendig ist nur die Variable "Name",
 	# Info ist in der Regel ebengalls anzupassen. Fuer alle uebrigen
-	# Variablen koennen oft die Defaults benutzt werden.
+	# Variablen koennen oft die Defaults benutzt werden, d.h. hier
+	# muss die Variable nicht angegeben werden.
 	#
 
 	# Servername im IRC-Netz
 	Name = irc.the.net
 
-	# Info-Text des Servers
+	# Info-Text des Servers. Dieser wird z.B. bei WHOIS- oder LINKS-
+	# Abfragen entsprechend mit ausgegeben.
 	Info = Server Info Text
 
 	# Ports, auf denen Verbindungen angenommen werden sollen. Es koennen
 	# mehrere Ports mit "," getrennt angegeben werden. (Default: 6667)
 	;Ports = 6667, 6668, 6669
 
-	# Textdatei mit der "Message of the Day" (MOTD)
+	# Textdatei mit der "Message of the Day" (MOTD). Diese wird aus-
+	# gegeben, wenn sich ein User mit dem Server verbindet.
 	;MotdFile = /usr/local/etc/ngircd.motd
 
 	# User-ID, unter der der Daemon laufen soll (dazu muss der Server
@@ -70,22 +76,24 @@
 [Server]
 
 	#
-	# In [Server]-Bloecken werden Server konfiguriert, zu denen dieser
+	# In [Server]-Bloecken werden Server konfiguriert, zu denen sich
-	# Server sich verbinden soll bzw. von denen Verbindungen angekommen
+	# dieser ngIRCd verbinden soll bzw. von denen Verbindungen angekommen
 	# werden duerfen.
 	# Es koennen mehrere Server konfiguriert werden, d.h. [Server]-
 	# Bloecke koennen mehrfach vorkommen.
-	# Ist fuer einen Server ein Port konfiguriert, so versucht dieser
+	# Wenn man fuer einen Server einen Port angegeben hat, dann versucht
-	# Server die Gegenseite zu connectieren. Ist kein Port vorgegeben,
+	# sich der ngIRCd mit der Gegenseite zu verbinden. Hat man keinen
-	# so wartet dieser Server auf eine Verbindung der Gegenseite.
+	# Port konfiguriert, dann wartet der ngIRCd darauf, dass sich die
+	# Gegenseite mit ihm verbindet.
 	#
 	# Server-Gruppen:
-	# Fuer jeden Server kann (optinal!) eine Gruppe konfiguriert werden,
+	# Der ngIRCd unterstuetzt "Server-Gruppen": das bedeutet, man kann
-	# zu der er gehoert (wird nur beachtet, wenn ein Port konfiguriert
+	# jedem Server, mit dem man sich verbinden will, einer Gruppe zu-
-	# ist!): eine solche Server-Gruppe wird quasi als ein Server ange-
+	# ordnen. Wenn der ngIRCd sich dann mit einem Server aus der Gruppe
-	# sehen, der ngIRCd baut also nur eine Verbindung auf. Schlaegt die
+	# verbinden will und keine Antwort erhaelt, dann wird der naechste
-	# Verbindung zu einem Server in einer Gruppe fehl, so wird der
+	# Server aus der Gruppe versucht.
-	# naechste Server in der Gruppe probiert.
+	# Achtung: Gruppen werden nur beachtet, wenn man einen Port fur
+	# die Gegenseite angegeben hat!
 	#
 
 	# Hostname des Servers